Cisco-IOS-XR-ipv4-pim-oper API API Reference
API generated from Cisco-IOS-XR-ipv4-pim-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{node-name}}/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
PIM-MA - Retrieve
Retrieve operation of resource: pim-ma
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standby": {
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
}
ACTIVE - Retrieve
Retrieve operation of resource: active
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-names": {
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
INTERFACE-BY-HANDLES - Retrieve
Retrieve operation of resource: interface-by-handles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-HANDLE - Retrieve
Retrieve operation of resource: interface-by-handle
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-BY-NAMES - Retrieve
Retrieve operation of resource: interface-by-names
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-NAME - Retrieve
Retrieve operation of resource: interface-by-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM-MA-SUMMARY - Retrieve
Retrieve operation of resource: pim-ma-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
STANDBY - Retrieve
Retrieve operation of resource: standby
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-names": {
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
INTERFACE-BY-HANDLES - Retrieve
Retrieve operation of resource: interface-by-handles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-HANDLE - Retrieve
Retrieve operation of resource: interface-by-handle
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-BY-NAMES - Retrieve
Retrieve operation of resource: interface-by-names
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-NAME - Retrieve
Retrieve operation of resource: interface-by-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM-MA-SUMMARY - Retrieve
Retrieve operation of resource: pim-ma-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
PIM - Retrieve
Retrieve operation of resource: pim
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
}
STANDBY - Retrieve
Retrieve operation of resource: standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
GLOBAL-INTERFACES - Retrieve
Retrieve operation of resource: global-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
GLOBAL-INTERFACE - Retrieve
Retrieve operation of resource: global-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
vrf-name
in path
string
ID of vrf-name
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
vrf-name
in path
string
ID of vrf-name
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
vrf-name
in path
string
ID of vrf-name
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ACTIVE - Retrieve
Retrieve operation of resource: active
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
GLOBAL-INTERFACES - Retrieve
Retrieve operation of resource: global-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
GLOBAL-INTERFACE - Retrieve
Retrieve operation of resource: global-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
vrf-name
in path
string
ID of vrf-name
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
vrf-name
in path
string
ID of vrf-name
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
vrf-name
in path
string
ID of vrf-name
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IPV6-PIM - Retrieve
Retrieve operation of resource: ipv6-pim
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
}
STANDBY - Retrieve
Retrieve operation of resource: standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
GLOBAL-INTERFACES - Retrieve
Retrieve operation of resource: global-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
GLOBAL-INTERFACE - Retrieve
Retrieve operation of resource: global-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
vrf-name
in path
string
ID of vrf-name
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
vrf-name
in path
string
ID of vrf-name
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
vrf-name
in path
string
ID of vrf-name
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ACTIVE - Retrieve
Retrieve operation of resource: active
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
GLOBAL-INTERFACES - Retrieve
Retrieve operation of resource: global-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
GLOBAL-INTERFACE - Retrieve
Retrieve operation of resource: global-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
RPF-HASH-SOURCE-GROUPS - Retrieve
Retrieve operation of resource: rpf-hash-source-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE-GROUP - Retrieve
Retrieve operation of resource: rpf-hash-source-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-HASH-SOURCES - Retrieve
Retrieve operation of resource: rpf-hash-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RPF-HASH-SOURCE - Retrieve
Retrieve operation of resource: rpf-hash-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-NEXT-HOP-ADDRESS - Retrieve
Retrieve operation of resource: secondary-next-hop-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPFS - Retrieve
Retrieve operation of resource: rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
RPF - Retrieve
Retrieve operation of resource: rpf
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
REGISTERED-ADDRESS-XR - Retrieve
Retrieve operation of resource: registered-address-xr
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-PATH - Retrieve
Retrieve operation of resource: rpf-path
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEXTHOP - Retrieve
Retrieve operation of resource: rpf-nexthop
vrf-name
in path
string
ID of vrf-name
registered-address
in path
string
ID of registered-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATISTICS - Retrieve
Retrieve operation of resource: interface-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
INTERFACE-STATISTIC - Retrieve
Retrieve operation of resource: interface-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
TOPOLOGY-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-route-count
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
JP-STATISTICS - Retrieve
Retrieve operation of resource: jp-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
JP-STATISTIC - Retrieve
Retrieve operation of resource: jp-statistic
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
MIB-DATABASES - Retrieve
Retrieve operation of resource: mib-databases
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
MIB-DATABASE - Retrieve
Retrieve operation of resource: mib-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBOR-OLD-FORMATS - Retrieve
Retrieve operation of resource: neighbor-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR-OLD-FORMAT - Retrieve
Retrieve operation of resource: neighbor-old-format
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-RANGE - Retrieve
Retrieve operation of resource: group-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-OLD-FORMATS - Retrieve
Retrieve operation of resource: interface-old-formats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE-OLD-FORMAT - Retrieve
Retrieve operation of resource: interface-old-format
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BSR - Retrieve
Retrieve operation of resource: bsr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
RP-CACHES - Retrieve
Retrieve operation of resource: rp-caches
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RP-CACHE - Retrieve
Retrieve operation of resource: rp-cache
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-PREFIX-XR - Retrieve
Retrieve operation of resource: group-prefix-xr
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RP-LIST - Retrieve
Retrieve operation of resource: candidate-rp-list
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
PIM-BSR-CRP-BAG - Retrieve
Retrieve operation of resource: pim-bsr-crp-bag
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
CANDIDATE-RP-ADDRESS - Retrieve
Retrieve operation of resource: candidate-rp-address
vrf-name
in path
string
ID of vrf-name
group-prefix
in path
string
ID of group-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CRP-ACCESS - Retrieve
Retrieve operation of resource: crp-access
vrf-name
in path
string
ID of vrf-name
rp-address
in path
string
ID of rp-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
BSR-ELECTIONS - Retrieve
Retrieve operation of resource: bsr-elections
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BSR-ELECTION - Retrieve
Retrieve operation of resource: bsr-election
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BSR-ADDRESS - Retrieve
Retrieve operation of resource: bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
CANDIDATE-BSR-ADDRESS - Retrieve
Retrieve operation of resource: candidate-bsr-address
vrf-name
in path
string
ID of vrf-name
pim-scope
in path
string
ID of pim-scope
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ROUTE-POLICY - Retrieve
Retrieve operation of resource: route-policy
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
ROUTE-POLICY-STATISTICS - Retrieve
Retrieve operation of resource: route-policy-statistics
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
ROUTE-POLICY-TESTS - Retrieve
Retrieve operation of resource: route-policy-tests
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
ROUTE-POLICY-TEST - Retrieve
Retrieve operation of resource: route-policy-test
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-SUMMARY - Retrieve
Retrieve operation of resource: rpf-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
DR-ADDRESS - Retrieve
Retrieve operation of resource: dr-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-ADDRESS - Retrieve
Retrieve operation of resource: interface-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NET-IO-TUNNELS - Retrieve
Retrieve operation of resource: net-io-tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NET-IO-TUNNEL - Retrieve
Retrieve operation of resource: net-io-tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-STATES - Retrieve
Retrieve operation of resource: bidir-df-states
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
BIDIR-DF-STATE - Retrieve
Retrieve operation of resource: bidir-df-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGIES - Retrieve
Retrieve operation of resource: topologies
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
TOPOLOGY - Retrieve
Retrieve operation of resource: topology
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SECONDARY-RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: secondary-rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-ROOT - Retrieve
Retrieve operation of resource: rpf-root
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROXY-ADDRESS - Retrieve
Retrieve operation of resource: proxy-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ORIG-SRC-ADDRESS - Retrieve
Retrieve operation of resource: orig-src-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
OUTGOING-INTERFACE - Retrieve
Retrieve operation of resource: outgoing-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
ASSERT-WINNER - Retrieve
Retrieve operation of resource: assert-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BGP-AFS - Retrieve
Retrieve operation of resource: bgp-afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
BGP-AF - Retrieve
Retrieve operation of resource: bgp-af
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
AUTO-RP - Retrieve
Retrieve operation of resource: auto-rp
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-interface-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-interface-flag-route-count
vrf-name
in path
string
ID of vrf-name
interface-flag
in path
string
ID of interface-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
GROUP-MAP-SOURCES - Retrieve
Retrieve operation of resource: group-map-sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
GROUP-MAP-SOURCE - Retrieve
Retrieve operation of resource: group-map-source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
SOURCE-OF-INFORMATION - Retrieve
Retrieve operation of resource: source-of-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
PACKET-QUEUE - Retrieve
Retrieve operation of resource: packet-queue
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
PACKET-QUEUE-STATE - Retrieve
Retrieve operation of resource: packet-queue-state
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PACKET-QUEUE-STATS - Retrieve
Retrieve operation of resource: packet-queue-stats
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
GROUP-MAP-RPFS - Retrieve
Retrieve operation of resource: group-map-rpfs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
GROUP-MAP-RPF - Retrieve
Retrieve operation of resource: group-map-rpf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
RPF-NEIGHBOR - Retrieve
Retrieve operation of resource: rpf-neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-MAP-INFORMATION - Retrieve
Retrieve operation of resource: group-map-information
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
GRE - Retrieve
Retrieve operation of resource: gre
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
GRE-HASHES - Retrieve
Retrieve operation of resource: gre-hashes
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
GRE-HASH - Retrieve
Retrieve operation of resource: gre-hash
vrf-name
in path
string
ID of vrf-name
source-address destination-address ifname
in path
string
ID of source-address destination-address ifname
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-interface": "string"
}
GRE-NEXT-HOPS - Retrieve
Retrieve operation of resource: gre-next-hops
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
REGISTERED-ADDRESS - Retrieve
Retrieve operation of resource: registered-address
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-PATH - Retrieve
Retrieve operation of resource: gre-path
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
GRE-NEIGHBOR - Retrieve
Retrieve operation of resource: gre-neighbor
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GRE-NEXT-HOP - Retrieve
Retrieve operation of resource: gre-next-hop
vrf-name
in path
string
ID of vrf-name
destination-address
in path
string
ID of destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BIDIR-DF-WINNERS - Retrieve
Retrieve operation of resource: bidir-df-winners
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
BIDIR-DF-WINNER - Retrieve
Retrieve operation of resource: bidir-df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
RP-ADDRESS-XR - Retrieve
Retrieve operation of resource: rp-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DF-WINNER - Retrieve
Retrieve operation of resource: df-winner
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TABLE-CONTEXTS - Retrieve
Retrieve operation of resource: table-contexts
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
TABLE-CONTEXT - Retrieve
Retrieve operation of resource: table-context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
NEIGHBOR-SUMMARIES - Retrieve
Retrieve operation of resource: neighbor-summaries
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
NEIGHBOR-SUMMARY - Retrieve
Retrieve operation of resource: neighbor-summary
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
CONTEXT - Retrieve
Retrieve operation of resource: context
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean"
}
REMOTE-DEFAULT-GROUP - Retrieve
Retrieve operation of resource: remote-default-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RPF-DEFAULT-TABLE - Retrieve
Retrieve operation of resource: rpf-default-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
EXPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: export-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
IMPORT-ROUTE-TARGET - Retrieve
Retrieve operation of resource: import-route-target
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
ANYCAST-RP-RANGE - Retrieve
Retrieve operation of resource: anycast-rp-range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNTS - Retrieve
Retrieve operation of resource: topology-entry-flag-route-counts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT - Retrieve
Retrieve operation of resource: topology-entry-flag-route-count
vrf-name
in path
string
ID of vrf-name
entry-flag
in path
string
ID of entry-flag
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
REDIRECT-ROUTE-DATABASES - Retrieve
Retrieve operation of resource: redirect-route-databases
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
REDIRECT-ROUTE-DATABASE - Retrieve
Retrieve operation of resource: redirect-route-database
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-XR - Retrieve
Retrieve operation of resource: source-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
RPF-ADDRESS - Retrieve
Retrieve operation of resource: rpf-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
BUNDLE-INTERFACES - Retrieve
Retrieve operation of resource: bundle-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
BUNDLE-INTERFACE - Retrieve
Retrieve operation of resource: bundle-interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
TUNNELS - Retrieve
Retrieve operation of resource: tunnels
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
TUNNEL - Retrieve
Retrieve operation of resource: tunnel
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: source-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS-NETIO - Retrieve
Retrieve operation of resource: group-address-netio
vrf-name
in path
string
ID of vrf-name
tunnel-name
in path
string
ID of tunnel-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
MULTICAST-STATIC-ROUTES - Retrieve
Retrieve operation of resource: multicast-static-routes
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
MULTICAST-STATIC-ROUTE - Retrieve
Retrieve operation of resource: multicast-static-route
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PREFIX - Retrieve
Retrieve operation of resource: prefix
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEXTHOP - Retrieve
Retrieve operation of resource: nexthop
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
NEIGHBOR-ADDRESS-XR - Retrieve
Retrieve operation of resource: neighbor-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM6-MA - Retrieve
Retrieve operation of resource: pim6-ma
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standby": {
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
}
ACTIVE - Retrieve
Retrieve operation of resource: active
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-names": {
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
INTERFACE-BY-HANDLES - Retrieve
Retrieve operation of resource: interface-by-handles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-HANDLE - Retrieve
Retrieve operation of resource: interface-by-handle
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-BY-NAMES - Retrieve
Retrieve operation of resource: interface-by-names
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-NAME - Retrieve
Retrieve operation of resource: interface-by-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM-MA-SUMMARY - Retrieve
Retrieve operation of resource: pim-ma-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
STANDBY - Retrieve
Retrieve operation of resource: standby
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-names": {
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
INTERFACE-BY-HANDLES - Retrieve
Retrieve operation of resource: interface-by-handles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-HANDLE - Retrieve
Retrieve operation of resource: interface-by-handle
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-handle
in path
string
ID of interface-handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-BY-NAMES - Retrieve
Retrieve operation of resource: interface-by-names
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BY-NAME - Retrieve
Retrieve operation of resource: interface-by-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
RP-ADDRESS - Retrieve
Retrieve operation of resource: rp-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM-MA-SUMMARY - Retrieve
Retrieve operation of resource: pim-ma-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
Schema Definitions
PIM-BSR-CRP-BAG:
PIM BSR C-RP
- pim-bsr-crp-bag: object[]
-
pim bsr crp bag
Example
{
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
STANDBY:
Common node of pim-ma, pim6-ma
- standby: PIM-MA-COMMON-OPER-PIM-MA-SUMMARY-MP
-
Standby Process
Example
{
"standby": {
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
}
RANGE-LIST-TABLE:
Common node of vrf, default-context
- ranges: object
-
PIM range list information
Example
{
"ranges": {
"range": [
{
"rp-address": "string",
"client": "string",
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
VRF-TABLE:
Common node of active, standby
- vrfs: object
-
VRF Table
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
PIM-GRE-PATH-BAG:
PIM GRE path information
- gre-next-hop: PIM-ADDRTYPE
-
GRE nexthop
- is-via-lsm: boolean
-
Via LSM
- is-gre-interface-disabled: boolean
-
Is the gre interface disabled ?
- gre-interface-name: string
-
GRE Interface
- is-connector-attribute-present: boolean
-
Connector attribute present
- gre-neighbor: PIM-ADDRTYPE
-
GRE neighbor
- extranet-vrf-name: string
-
Extranet VRF name
Example
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
PIM-GRP-MAP-BAG:
PIM group-map basic information
- group-count: integer
-
No. of groups in this range
- rp-address: PIM-ADDRTYPE
-
Rendezvous Point Address
- protocol: string no-route, sm, dm, bidir, ssm, maximum, any
-
Protocol mode of the range
- is-used: boolean
-
Is this mapping being used?
- mrib-active: boolean
-
Is this mapping active in MRIB?
- is-override: boolean
-
Is this the override range?
- priority: integer
-
Bootstrap priority
- prefix: PIM-ADDRTYPE
-
Group range prefix
- client: string no-client, embedded-config, embedded, permanent, auto-rp, bsr, config, static
-
Client mapping learnt from
- prefix-length: string
-
Group range prefix length
Example
{
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
}
RPF-SUMMARY:
Common node of vrf, default-context
- rpf-summary: PIM-RPF-SUMMARY-BAG
-
PIM RPF registration summary
Example
{
"rpf-summary": {
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
}
PIM-BIDIR-DF-STATE-BAG:
PIM Bidirectional DF state
- pim-interface-name: string
-
Interface Name
- time-nano-seconds: integer
-
Timer expires (nseconds)
- rp-address-xr: PIM-ADDRTYPE
-
RP Address
- our-metric: integer
-
Metric
- time-seconds: integer
-
Timer expires (seconds)
- our-metric-preference: integer
-
MetricPreference
- election-state: string
-
DF Election State
Example
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
PIM-JPSTATS-BAG:
PIM join-prune statistic
- received: integer
-
Received
- transmitted100: integer
-
Transmitted 100 average
- transmitted-1k: integer
-
Transmitted 1K average
- received-1k: integer
-
Received 1K average
- mtu: integer
-
Interface MTU
- received100: integer
-
Received 100 average
- transmitted: integer
-
Transmitted
- interface-name-xr: string
-
Interface Identifier
- received-50k: integer
-
Deprecated by Received100
- transmitted-50k: integer
-
Deprecated by Transmitted100
- received-10k: integer
-
Received 10K average
- transmitted-10k: integer
-
Transmitted 10K average
Example
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
PIM-NSF-BAG:
PIM NSF state
- last-icd-notif-recv-sec: string
-
Last ICD Notif Recv in Seconds
- last-nsf-off: string
-
Last NSF time off
- configured-state: boolean
-
Is Multicast NSF Configured
- last-icd-notif-recv: string
-
Last ICD Notif Recv
- waiting-timer: boolean
-
Waiting for NSF timer expiry
- nsf-timeout: integer
-
Multicast NSF timeout in seconds
- respawn-count: integer
-
Respawn Count
- nsf-time-left: integer
-
Multicast NSF time left in seconds
- last-nsf-off-sec: string
-
Last NSF time OFF in Seconds
- last-nsf-on-sec: string
-
Last NSF time ON in Seconds
- nsf-state: boolean
-
Are we currently in NSF
- last-nsf-on: string
-
Last NSF time ON
- waiting-membership: boolean
-
Waiting for IGMP/MLD
Example
{
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
}
PIM-IFSTATS-BAG:
PIM Interface Statistics
- input-register-stop: integer
-
Register Stop packets in
- input-graft-message: integer
-
Input Graft Messages
- input-graft-ack-message: integer
-
Input Graft Ack Messages
- output-hello: integer
-
Hello packets out
- output-df-election: integer
-
DF Election packets out
- output-register-stop: integer
-
Register Stop packets out
- input-miscellaneous: integer
-
Miscellaneous packet in
- output-assert: integer
-
Assert packets out
- output-graft-ack-message: integer
-
Output Graft Ack Messages
- output-candidate-rp-advertisement: integer
-
Output Candidate-RP Advertisment
- input-bsr-message: integer
-
Input BSR Messages
- input-assert: integer
-
Assert packets in
- input-register: integer
-
Register packets in
- input-df-election: integer
-
DF Election packets in
- output-jp: integer
-
Join Prune packets out
- input-hello: integer
-
Hello packets in
- output-graft-message: integer
-
Output Graft Messages
- input-jp: integer
-
Join Prune packets in
- output-register: integer
-
Register packets out
- output-bsr-message: integer
-
Output BSR Messages
- input-candidate-rp-advertisement: integer
-
Input Candidate-RP Advertisment
Example
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
PIM-RPF-RDRCT-RINTF-BAG:
PIM RPF-redirct bundle non-local route OLE information
- rpf-address: PIM-ADDRTYPE
-
RPF Address
- uptime: integer
-
Uptime in seconds
- is-rpf-interface: boolean
-
Is RPF Interface
- expiry: integer
-
Expiry in seconds
- is-snoop-interface: boolean
-
Is snooping Interface
- is-outgoing-interface: boolean
-
Is outgoing Interface
- interface-name: string
-
Interface name
Example
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
PIM-RL-BAG:
PIM range list information
- protocol: string no-route, sm, dm, bidir, ssm, maximum, any
-
PIM protocol
- group-range: PIM-RL-RP-RANGE-BAG
-
List of group ranges
- client-xr: string no-client, embedded-config, embedded, permanent, auto-rp, bsr, config, static
-
Client mapping learnt via
- expires: integer
-
When mapping expires
- rp-address-xr: PIM-ADDRTYPE
-
Rendezvous point address
- source-of-information: PIM-ADDRTYPE
-
Source of information
Example
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
BGP-AF-TABLE:
Common node of vrf, default-context
- bgp-afs: object
-
PIM BGP SAFI table
Example
{
"bgp-afs": {
"bgp-af": [
{
"group-address": "string",
"source-address": "string",
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
PIM-BSR-RP-CACHE-BAG:
PIM BSR RP cache
- group-prefix-length: integer
-
Group Prefix Length
- candidate-rp-list: PIM-BSR-CRP-BAG
-
C-RP list for this prefix
- candidate-rp-group-count: integer
-
C-RP count for this Prefix
- group-prefix-xr: PIM-ADDRTYPE
-
Group Prefix
Example
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PROCESS:
Common node of active, standby
- process: object
-
Process
Example
{
"process": {
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
}
IPV4-PIM-COMMON-OPER-INTERFACE-TABLE:
Common node of active, standbyCommon node of vrf, default-context
- interfaces: object
-
PIM interfaces
Example
{
"interfaces": {
"interface": [
{
"interface-name": "string",
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
}
PIM-MROUTE-BAG:
Multicast Route MIB entry
- uptime: integer
-
Uptime of route
- rpf-neighbor: PIM-ADDRTYPE
-
The RPF Neighbor
- protocol: string no-route, sm, dm, bidir, ssm, maximum, any
-
The PIM protocol
- rpf-mask: integer
-
Mask of the multicast root
- rpf-drop: boolean
-
RPF route-policy drop
- rpf-vrf-name: string
-
RPF VRF Name
- rpf-interface-name: string
-
RPF interface name
- assert-metric-preference: integer
-
Assert Metric Preference
- group-address-xr: PIM-ADDRTYPE
-
Group Address
- assert-metric: integer
-
Assert Metric
- assert-rpt-bit: boolean
-
Assert RPT Bit
- rpf-safi: integer
-
Unicast or mcast
- source-address-xr: PIM-ADDRTYPE
-
Source Address
- rpf-table-name: string
-
RPF Table name
- bidirectional-route: boolean
-
Is this Bidir ?
- rpf-extranet: boolean
-
Extranet RPF route-policy
- upstream-assert-timer: string
-
Upstream Assert Timer
- rpf-root: PIM-ADDRTYPE
-
Root of this mcast tree
- spt-bit: boolean
-
Is SPT bit set ?
Example
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
PIM-NSR-BAG:
NSR Related information
- count-connection-up: integer
-
No. of times connection went up
- rmf-notification-done: boolean
-
RMF Notification done
- last-rmf-not-ready: integer
-
Time when RMF Not-Rdy notif was sent
- count-rmf-ready: integer
-
No. of times RMF Ready notif was sent
- partner-connected: boolean
-
Partner process connected
- state: integer
-
NSR state
- count-rmf-not-ready: integer
-
No. of times RMF Not Ready notif was sent
- rmf-timer-expiry: integer
-
Time for RMF timer to expire
- count-connection-dn: integer
-
No. of times connection went down
- last-connection-dn: integer
-
Time when connection went down
- last-connection-up: integer
-
Time when connection went up
- last-rmf-ready: integer
-
Time when RMF Rdy notif was sent
- rmf-timer-valid: boolean
-
Is RMF timer running ?
Example
{
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
}
PIM-BSR-ELECTION-BAG:
PIM BSR Election State
- bsr-up-time: integer
-
BSR Uptime
- bsr-scope: integer
-
BSR Scope
- bsr-address: PIM-ADDRTYPE
-
BSR address
- bsr-priority: integer
-
BSR Priority
- candidate-bsr-mask-length: integer
-
C-BSR Hash Func. Mask Len
- candidate-bsr-state: integer
-
BSR Candidate State
- candidate-bsr-priority: integer
-
C-BSR Priority
- bsr-election-state: integer
-
BSR Election State
- candidate-bsr-flag: boolean
-
BSR Candidate Config Flag
- bsr-mask-length: integer
-
Hash Function Mask Length
- bootstrap-timeout: integer
-
Bootstrap Timeout
- candidate-bsr-address: PIM-ADDRTYPE
-
C-BSR address
Example
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PIM-TT-ROUTE-BAG:
PIM topology table route
- outgoing-interface: PIM-TT-OLE-BAG
-
Outgoing interface list
- protocol: string no-route, sm, dm, bidir, ssm, maximum, any
-
The PIM protocol
- sa-sent: boolean
-
BGP SA sent
- register-received-timer: string
-
Register Received Timer in seconds (-1 if never)
- spt: boolean
-
Is this on the SPT ?
- alive: string
-
Alive time in seconds (-1 if never)
- customer-routing-type: string
-
Type of Customer Routing in the MVPN
- inherit-spt: boolean
-
The Inherit SPT Bit
- signal-sources: boolean
-
Signal Sources on route?
- remote-source: boolean
-
MSDP told us
- anycast-rp-route-target: string
-
Anycast-RP RT
- uptime: integer
-
Uptime in seconds
- rp-address: PIM-ADDRTYPE
-
RP Address (If rpt)
- register-received: boolean
-
Have registers been received for this source ?
- limit-reached: boolean
-
Have we throttled the creation of routes or interfaces ?
- rpf-drop: boolean
-
RPF route-policy drop
- rpf-vrf-name: string
-
RPF VRF Name
- low-memory: boolean
-
Node is running low on memory
- orig-src-address: PIM-ADDRTYPE
-
Orig Src Address.
- rpf-proxy-enabled: boolean
-
Is rpf if proxy enabled?
- sa-received: boolean
-
BGP SA received
- sending-null-registers: boolean
-
Are we sending null registers for this route ?
- rpf-safi: integer
-
Unicast or mcast
- sending-registers: boolean
-
Are we sending registers for this route ?
- anycast-rp-match: boolean
-
Group matches Anycast-RP policy
- rib-mo-frr-enabled: boolean
-
Is this SG MoFRR enabled?
- rpf-extranet: boolean
-
Extranet RPF route-policy
- rpt-xr: boolean
-
Is this on the RPT ?
- data-mdt-addr-assigned: boolean
-
PIM has assigned a Data MDT Address
- vxlan: boolean
-
Is this VXLAN?
- mofrr-active: boolean
-
Is MoFRR Active?
- sa-joined: boolean
-
BGP SA join
- crossed-threshold: boolean
-
Incoming traffic crossed threshold. MT flag set
- rpf-interface-name: string
-
Interface Identifier
- secondary-rpf-interface-name: string
-
Secondary Interface Identifier
- is-via-lsm: boolean
-
Via LSM
- mofrr-backup: boolean
-
Is this Mofrr Backup?
- bgp-join: boolean
-
BGP C JOIN
- group-address-xr: PIM-ADDRTYPE
-
Group Address
- expiry: integer
-
When this entry expires
- suppress-registers: string
-
When the Null register probe expires
- rpf-neighbor: PIM-ADDRTYPE
-
RPF Neighbor
- connected: boolean
-
Is Connected ?
- proxy: boolean
-
Is the RPF target a proxy?
- source-address-xr: PIM-ADDRTYPE
-
Source Address
- rpf-table-name: string
-
RPF Table name
- dont-check-connected: boolean
-
Do we need to make the connected check on this route ?
- proxy-address: PIM-ADDRTYPE
-
RPF Proxy address.
- assume-alive: boolean
-
The Assume Alive Bit
- mofrr-enabled: boolean
-
Is this SG MoFRR enabled?
- inherit-alive: boolean
-
The Inherit Alive Bit
- kat-state: boolean
-
Keep Alive Timer State
- secondary-rpf-neighbor: PIM-ADDRTYPE
-
Secondary RPF Neighbor
- jp-status: string
-
Join-Prune Status
- jp-timer: string
-
Join-Prune Timer
- mofrr-primary: boolean
-
Is this Mofrr Primary?
- bgp-jp-time: integer
-
BGP C JP Time
- really-alive: boolean
-
The Really Alive Bit
- wildcard: boolean
-
WC -Wildcard
- probe-alive: boolean
-
The Probe Alive Bit
- rpf-root: PIM-ADDRTYPE
-
Root of this mcast tree
- last-hop: boolean
-
Are we last hop ?
- extranet-route: boolean
-
Is a Extranet route ?
Example
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string"
}
}
INTERFACE-STATISTICS-TABLE:
Common node of vrf, default-context
- interface-statistics: object
-
PIM interface statistics
Example
{
"interface-statistics": {
"interface-statistic": [
{
"interface-name": "string",
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
}
GROUP-MAP-RPF-TABLE:
Common node of vrf, default-context
- group-map-rpfs: object
-
PIM group mapping information
Example
{
"group-map-rpfs": {
"group-map-rpf": [
{
"rp-address": "string",
"protocol": "string",
"rp-priority": "integer",
"prefix": "string",
"client": "string",
"prefix-length": "integer",
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
}
PIM-NBR-BAG:
PIM neighbor information
- uptime: integer
-
Uptime in seconds
- is-bfd-state: boolean
-
Is the neighbor bfd session created
- is-bidirectional-capable: boolean
-
Is this neighbor bidir capable ?
- neighbor-address-xr: PIM-ADDRTYPE
-
List of Neighbor Addresses
- expires: integer
-
Neighbor expiry in seconds
- is-ecmp-redirect-capable: boolean
-
Is this neighbor capable of Ecmp Redirect?
- is-this-neighbor-us: boolean
-
Is this neighbor us ?
- is-dr-priority-capable: boolean
-
Is this neighbor DR priority capable ?
- override-interval: integer
-
Override Interval
- is-this-neighbor-dr: boolean
-
Is this neighbor the DR
- propagation-delay: integer
-
Propagation Delay
- interface-name-xr: string
-
Interface Identifier
- dr-priority: integer
-
DR priority
- is-proxy-capable: boolean
-
Is this neighbor proxy capable?
- expiry-timer: integer
-
Expiry timer in seconds
- is-batch-asserts-capable: boolean
-
Is this neighbor capable of batching asserts?
Example
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
CONTEXT:
Common node of vrf, default-context
- context: PIM-CONTEXT-BAG
-
PIM context information
Example
{
"context": {
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean"
}
}
NEIGHBOR-OLD-FORMAT-TABLE:
Common node of vrf, default-context
- neighbor-old-formats: object
-
PIM neighbor table old format
Example
{
"neighbor-old-formats": {
"neighbor-old-format": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
PIM-BIDIR-DF-BAG:
PIM Bidirectional DF entry
- uptime: integer
-
Uptime in seconds
- pim-interface-name: string
-
Interface Name
- df-winner: PIM-ADDRTYPE
-
DF Winner
- metric: integer
-
Metric
- are-we-df: boolean
-
Are we DF
- rp-address-xr: PIM-ADDRTYPE
-
RP Address
- metric-preference: integer
-
Metric Preference
- rp-lan: boolean
-
Is this the RP LAN
Example
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
PIM-BSR-CANDIDATE-RP-BAG:
PIM BSR Candidate RP
- candidate-rp-advance-interval: integer
-
Cand-RP Adv Interval in seconds
- candidate-rp-uptime: integer
-
Cand-RP uptime
- candidate-rp: PIM-ADDRTYPE
-
Cand-RP Address
- acl-name: string
-
Group Access-List Name
- crp-holdtime: integer
-
Cand-RP Holdtime
- candidate-rp-scope: string
-
Cand-RP Scope
- crp-priority: integer
-
Cand-RP Priority
- crp-access: PIM-BSR-CRP-ACL-BAG
-
Group Ranges Using this Cand-RP
- candidate-rp-mode: string no-route, sm, dm, bidir, ssm, maximum, any
-
Cand-RP Mode
Example
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
NEIGHBOR-TABLE:
Common node of vrf, default-context
- neighbors: object
-
PIM neighbor table
Example
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
TABLE-CONTEXT-TABLE:
Common node of vrf, default-context
- table-contexts: object
-
PIM table context list
Example
{
"table-contexts": {
"table-context": [
{
"saf-name": "string",
"topology-name": "string",
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
}
PIM-BSR-CRP-ACL-BAG:
PIM BSR Candidate RP Access-list
- acl-name: string
-
Group Access-List Name
- candidate-rp-mode: string no-route, sm, dm, bidir, ssm, maximum, any
-
Cand-RP Mode
Example
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
IFRS-SUMMARY:
Common node of vrf, default-context
- ifrs-summary: PIM-IDB-SUMM-BAG
-
PIM interfaces in forward reference store summary
Example
{
"ifrs-summary": {
"interface-count": "integer",
"configuration-count": "integer"
}
}
SAF-TABLE:
Common node of vrf, default-context
- safs: object
-
SAFI table and type
Example
{
"safs": {
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"group-address": "string",
"mask-length": "integer",
"source-address": "string",
"mofrr": "integer",
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"registered-address": "string",
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"source-address": "string",
"mofrr": "integer",
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
}
PIM-ANYCAST-RP-ENTRY:
PIM Anycast RP entry
- ancast-rp-marked: boolean
-
Anycast-RP Range marked
- prefix: PIM-ADDRTYPE
-
Anycast-RP Range Prefix
- prefix-length: integer
-
Anycast-RP Range Prefix Length
Example
{
"ancast-rp-marked": "boolean",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "integer"
}
PIM-TT-OLE-BAG:
PIM topology OLE information
- forwarding-state: string
-
Forward or Prune
- bgp-c-mcast-join: boolean
-
BGP C-Mcast join
- jp-timer: string
-
Join-Prune Timer (secs)
- mvpn-safi-join: boolean
-
MVPN Safi join
- internal-interest-info: string
-
Internal Interest. Deprecated - use 'internal-interest-information' instead
- assert-state: boolean
-
Assert State
- mdt-safi-join: boolean
-
MDT Safi join
- mldp-stale: boolean
-
OLE is stale
- uptime: integer
-
Uptime in seconds
- extranet-interface: boolean
-
Is this an Extranet Interface ?
- jp-state: string
-
Join-Prune State
- immediate-state: string
-
Immediate fwding state
- vrf-name: string
-
VRF which physically owns
- mldp-inband-mdt: boolean
-
MLDP Inband MDT interface
- local-members: string
-
Local Information. Deprecated - use 'local-members-information' instead
- expiry: integer
-
Expiry in seconds
- assert-timer: string
-
Assert Timer in seconds
- local-members-information: string null, li, ld
-
Local Information. Replaces local-members
- assert-winner: PIM-ADDRTYPE
-
Assert Winner
- bgp-c-mcast-prune-delay-timer: integer
-
BGP C-MCAST Prune Suppression in seconds
- sa-prune: boolean
-
BGP SA Prune state
- admin-boundary: boolean
-
Is this an administrative boundary ?
- interface-name: string
-
Interface Identifier
- igmp-membership: boolean
-
IGMP membership
- mvpnv6-safi-join: boolean
-
MVPN IPv6 Safi join
- last-hop: boolean
-
Are we last hop ?
- internal-interest-information: string null, ii, id
-
Internal Interest. Replaces internal-interest-info
- data-mdt-join: boolean
-
Data MDT join
- local-mdt-join: boolean
-
Default MDT Join
Example
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
BIDIR-DF-STATE-TABLE:
Common node of vrf, default-context
- bidir-df-states: object
-
Bidirectional PIM DF election state table
Example
{
"bidir-df-states": {
"bidir-df-state": [
{
"rp-address": "string",
"interface-name": "string",
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
}
PIM-RPF-SUMMARY-BAG:
PIM RPF count summary
- is-ospf-te-configured: boolean
-
Is OSPF TE configured?
- default-table-name: string
-
Default RPF Table Name
- rib-mo-frr-configured: boolean
-
Is MoFRR RIB configured?
- is-mbgp-configured: boolean
-
Is MBGP configured?
- is-multipath-enabled: boolean
-
Is Multipath Enabled ?
- rpf-registrations: integer
-
RPF Registration count
- is-multipath-source-next-hop-hash-enabled: boolean
-
Is Multipath Source-Nexthop Hash Enabled ?
- rump-enabled: boolean
-
Is RUMP MuRIB enabled?
- rib-convergence-time-left: integer
-
RIB convergence time left in seconds
- is-multipath-source-hash-enabled: boolean
-
Is Multipath Source based Hash Enabled ?
- default-safi: integer
-
Default RPF Table SAFI
- is-isis-te-configured: boolean
-
Is ISIS TE configured?
- is-isis-mtr-configured: boolean
-
Is ISIS MTR configured?
- is-rib-convergence: boolean
-
RIB Convergence status
- is-multipath-interface-hash-enabled: boolean
-
Is Multipath Interface Hash Extension Enabled ?
- rib-convergence-timeout: integer
-
RIB convergence timeout in seconds
- mo-frr-configured: boolean
-
Is MoFRR configured?
Example
{
"is-ospf-te-configured": "boolean",
"default-table-name": "string",
"rib-mo-frr-configured": "boolean",
"is-mbgp-configured": "boolean",
"is-multipath-enabled": "boolean",
"rpf-registrations": "integer",
"is-multipath-source-next-hop-hash-enabled": "boolean",
"rump-enabled": "boolean",
"rib-convergence-time-left": "integer",
"is-multipath-source-hash-enabled": "boolean",
"default-safi": "integer",
"is-isis-te-configured": "boolean",
"is-isis-mtr-configured": "boolean",
"is-rib-convergence": "boolean",
"is-multipath-interface-hash-enabled": "boolean",
"rib-convergence-timeout": "integer",
"mo-frr-configured": "boolean"
}
PIM-TUNNEL-INFO-BAG:
PIM tunnel information
- source-address-netio: PIM-ADDRTYPE
-
Source addr from netio
- rp-address: PIM-ADDRTYPE
-
RP addr known to PIM
- vrf-name: string
-
VRF Name
- source-address: PIM-ADDRTYPE
-
Source addr known to PIM
- group-address-netio: PIM-ADDRTYPE
-
Group addr from netio
Example
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GRE:
Common node of vrf, default-context
- gre: object
-
GRE information
Example
{
"gre": {
"gre-next-hops": {
"gre-next-hop": [
{
"destination-address": "string",
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"ifname": "string",
"destination-address": "string",
"source-address": "string",
"next-hop-interface": "string"
}
]
}
}
}
ACTIVE:
Common node of pim-ma, pim6-ma
- active: PIM-MA-COMMON-OPER-PIM-MA-SUMMARY-MP
-
Active Process
Example
{
"active": {
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
}
DEFAULT-CONTEXT:
Common node of active, standby
- default-context:
-
Default Context
Example
{
"default-context": {
"global-interfaces": {
"global-interface": [
{
"interface-name": "string",
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
},
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
}
PIM-NBR-SUMM-BAG:
PIM neighbor summary
- number-of-neighbors: string
-
Number of neighbors
- number-of-external-neighbors: string
-
Number of external neighbors
Example
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
GROUP-MAP-SOURCE-TABLE:
Common node of vrf, default-context
- group-map-sources: object
-
PIM group-mapping with source information
Example
{
"group-map-sources": {
"group-map-source": [
{
"rp-address": "string",
"protocol": "string",
"priority": "integer",
"prefix": "string",
"client": "string",
"prefix-length": "integer",
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
}
TOPOLOGY-INTERFACE-FLAG-ROUTE-COUNT-TABLE:
Common node of vrf, default-context
- topology-interface-flag-route-counts: object
-
Route count for topology with interface flag set
Example
{
"topology-interface-flag-route-counts": {
"topology-interface-flag-route-count": [
{
"interface-flag": "string",
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
}
TOPOLOGY-ENTRY-FLAG-ROUTE-COUNT-TABLE:
Common node of vrf, default-context
- topology-entry-flag-route-counts: object
-
Route count for topology with entry flag set
Example
{
"topology-entry-flag-route-counts": {
"topology-entry-flag-route-count": [
{
"entry-flag": "string",
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
}
PIM-RPF-POLICY-STATS-BAG:
PIM RPF policy statistics
- policy-name: string
-
RPF policy name
- drop: integer
-
Number of RPF drops
- default-table: integer
-
Number of RPF lookup in default-only Table
- pass: integer
-
Number of RPF pass
- requests: integer
-
Number of RPF lookup requests
- any-table: integer
-
Number of RPF lookup in any Table
Example
{
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
}
IFRS-INTERFACE-TABLE:
Common node of vrf, default-context
- ifrs-interfaces: object
-
PIM interfaces in forward reference store table
Example
{
"ifrs-interfaces": {
"ifrs-interface": [
{
"interface-name": "string",
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
}
IPV4-PIM-ROLE-LVL-OPER-ACTIVE:
Common node of pim-ma, pim6-maCommon node of pim, ipv6-pim
- active: VRF-TABLE
-
Active Process
Example
{
"active": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
}
PIM-IDB-BAG:
PIM interface
- join-prune-interval: integer
-
Join-Prune Interval
- override-interval: integer
-
Override Interval
- is-bidirectional-capable: boolean
-
Bidir Capable
- generation-id: integer
-
Generation Identifier
- virtual-interface: boolean
-
is this a Virtual Interfaces ?
- propagation-delay: integer
-
Propagation Delay
- interface-name-xr: string
-
Interface Identfier
- idb-acl-provided: boolean
-
ACL name provided
- idb-current-count: integer
-
Interface ole current count
- is-batch-asserts-capable: boolean
-
Batch Asserts Capable
- neighbor-count: integer
-
No. of neighbors on this IF
- configured-propagation-delay: integer
-
Configured Propagation Delay
- interface-address: PIM-ADDRTYPE
-
List of Interface IP Addresses
- idb-acl-name: string
-
Interface ole ACL Name
- neighbor-filter-name: string
-
Neighbor Filter Name
- idb-max-count: integer
-
Interface ole max count
- idb-oor-enabled: boolean
-
Interface oor enabled
- dr-priority: integer
-
DR Priority
- is-proxy-capable: boolean
-
Proxy Capable
- prune-delay-enabled: boolean
-
Prune Delay Enabled
- hello-interval: integer
-
Hello Interval
- bfd-multiplier: integer
-
BFD Multiplier
- interface-address-mask: integer
-
Interface IP Address Mask
- is-enabled: boolean
-
Is PIM enabled on this IF ?
- passive-interface: boolean
-
Passive PIM interface
- dr-address: PIM-ADDRTYPE
-
PIM Designated Router
- idb-threshold-count: integer
-
Interface ole threshold count
- hello-expiry: integer
-
Hello Timer Expiry
- bfd-interval: integer
-
BFD Interval
- bfd-enabled: boolean
-
BFD state
- external-neighbor-count: integer
-
No. of external neighbors on this IF
- are-we-dr: boolean
-
Are we the DR on this IF ?
- configured-override-interval: integer
-
Configured Override Interval
Example
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
PIM-TABLE-CTX-BAG:
PIM Table context
- is-ital-registration-done: boolean
-
ITAL reg status
- afi: integer
-
AFI
- safi: integer
-
SAFI
- table-id: integer
-
Table ID
- rpf-registrations: integer
-
RPF Registration count
- vrf-id: integer
-
VRF ID
- is-rib-convergence-received: boolean
-
RIB Convergence receive status
- is-active: boolean
-
Active status
- is-rib-registration-done: boolean
-
RIB reg status
- is-rib-convergence: boolean
-
RIB Convergence status
- table-name: string
-
Table name
Example
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
BIDIR-DF-WINNER-TABLE:
Common node of vrf, default-context
- bidir-df-winners: object
-
Bidirectional PIM DF election winner table
Example
{
"bidir-df-winners": {
"bidir-df-winner": [
{
"rp-address": "string",
"interface-name": "string",
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
}
TRAFFIC-COUNTERS:
Common node of vrf, default-context
- traffic-counters: PIM-TRAFFIC-BAG
-
PIM message traffic counters
Example
{
"traffic-counters": {
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
}
PIM-RPF-PATH-BAG:
PIM RPF path information
- connector: string
-
Connector Attribute
- rpf-neighbor: PIM-ADDRTYPE
-
RPF neighbor
- rpf-interface-name: string
-
RPF Interface
- is-via-lsm: boolean
-
Via LSM
- rpf-nexthop: PIM-ADDRTYPE
-
RPF nexthop
- is-rpf-interface-disabled: boolean
-
Is the rpf interface disabled ?
- is-connector-attribute-present: boolean
-
Connector attribute present
- is-via-mlsm: boolean
-
Via Mstatic LSM
- extranet-vrf-name: string
-
Extranet VRF name
Example
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
PIM-RPF-HASH-BAG:
PIM RPF Hash Outcome
- next-hop-interface: string
-
Next hop neighbor interface
- next-hop-multipath-enabled: boolean
-
Next hop multipath enabled?
- secondary-next-hop-address: PIM-ADDRTYPE
-
Secondary Next hop neighbor address
- secondary-next-hop-interface: string
-
Secondary Next hop neighbor interface
- next-hop-address: PIM-ADDRTYPE
-
Next hop neighbor address
Example
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PIM-PKTQ:
PIM packet queue state and statistics
- packet-queue-stats: PIM-PKTQ-STATS
-
Statistics about the queue
- packet-queue-state: PIM-PKTQ-STATE
-
State of the queue
- packet-queue-priority: integer
-
Priority of this packet queue
Example
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
NEIGHBOR-SUMMARY-TABLE:
Common node of vrf, default-context
- neighbor-summaries: object
-
PIM neighbor summary table
Example
{
"neighbor-summaries": {
"neighbor-summary": [
{
"interface-name": "string",
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
}
BSR:
Common node of vrf, default-context
- bsr: object
-
PIM BSR information
Example
{
"bsr": {
"bsr-elections": {
"bsr-election": [
{
"pim-scope": "integer",
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"rp-address": "string",
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix": "string",
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
}
PIM-GRP-MAP-INFOSRC-BAG:
PIM group-map source information
- group-map-information: PIM-GRP-MAP-BAG
-
Group Mapping information
- uptime: integer
-
Mapping uptime in seconds
- source-of-information: PIM-ADDRTYPE
-
The source of information
- holdtime: string
-
Holdtime in seconds
- expires: integer
-
Mapping expiry time in seconds
Example
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
PIM-GRE-INFO-BAG:
PIM GRE information
- gre-path: PIM-GRE-PATH-BAG
-
GRE Paths list
- is-connected: integer
-
Are we connected ?
- metric: integer
-
Metric
- metric-preference: integer
-
Metric preference
- registered-address: PIM-ADDRTYPE
-
Address registered
Example
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PIM-SUMMARY-BAG:
PIM Summary Bag
- global-bsr-candidate-rp-set-threshold: integer
-
Global BSR Threshold crp-set
- is-global-register-limit-reached: boolean
-
Is global PIM SM register handling throttled
- route-low-water-mark: integer
-
The number of routes below which the throttle on route creation will be lifted
- global-bsr-ranges-limit: integer
-
Global BSR maximum group ranges
- route-count: integer
-
Current routes
- ranges-threshold: integer
-
OOR theshold of grange ranges from AutoRP
- global-bsr-candidate-rp-set-limit: integer
-
Global BSR maximum crp-set
- is-global-bsr-ranges-limit-reached: boolean
-
Is global BSR group-to-RP mapping range creation throttled
- ranges-count: integer
-
Current group ranges from Autorp
- route-limit: integer
-
Maximum routes
- bsr-range-threshold: integer
-
Threshold group range from BSR
- is-global-route-limit-reached: boolean
-
Is global route creation throttled
- global-auto-rp-ranges-limit: integer
-
Global Auto-RP maximum group ranges
- is-ranges-limit-reached: boolean
-
Is Auto-RP group-to-RP mapping range creation throttled
- global-bsr-candidate-rp-set-count: integer
-
Global BSR current crp-set count
- global-bsr-ranges-count: integer
-
Global BSR current group ranges
- route-threshold: integer
-
Threshold routes
- bsr-ranges-count: integer
-
Current group ranges from BSR
- topology-interface-state-threshold: integer
-
Topology Interface State threshold
- rxi-low-water-mark: integer
-
The rxi below which the throttle on interface creation will be lifted
- register-limit-reached: boolean
-
Is PIM SM register handling throttled
- register-threshold: integer
-
Threshold registers
- rxi-limit-reached: boolean
-
Is interface creation throttled
- bsr-candidate-rp-set-limit: integer
-
Maximum crp-set from BSR
- is-global-rxi-limit-reached: boolean
-
Is global interface creation throttled
- topology-interface-state-limit: integer
-
Maximum Topology Interface State count
- global-register-limit: integer
-
Maximum global registers
- register-limit: integer
-
Maximum registers
- bsr-ranges-limit: integer
-
Maximum group ranges from BSR
- is-maximum-enforcement-disabled: boolean
-
Is maximum enforcement disabled
- global-bsr-ranges-threshold: integer
-
Global BSR Threshold group ranges
- is-node-low-memory: boolean
-
Is node in low memory condition
- is-route-limit-reached: boolean
-
Is route creation throttled
- ranges-limit: integer
-
Maximum group ranges from Autorp
- bsr-candidate-rp-set-count: integer
-
Current crp-set count from BSR
- topology-interface-state-count: integer
-
Current Topology Interface State count
- is-global-auto-rp-ranges-limit-reached: boolean
-
Is global AutoRP group-to-RP mapping range creation throttled
- is-bsr-ranges-threshold-reached: boolean
-
Is VRF-specific BSR group-to-RP mapping range creation throttled
- bsr-candidate-rp-set-threshold: integer
-
Threshold crp-set from BSR
- register-count: integer
-
Current registers
Example
{
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
PIM-MA-SUMMARY:
PIM MA Summary
- is-edm-connection-open: boolean
-
EDM Connection Open
- is-im-connection-open: boolean
-
IM Connection Open
- decap-interface-count: integer
-
Decap Interface Count
- is-standby-edm-connection-open: boolean
-
Standby EDM Connection Open
- is-netio-connection-open: boolean
-
Netio Connection Open
- encap-interface-count: integer
-
Encap Interface Count
- mdt-interface-count: integer
-
MDT Interface Count
Example
{
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
SUMMARY:
Common node of vrf, default-context
- summary: PIM-SUMMARY-BAG
-
PIM summary
Example
{
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
PIM-IDB-SUMM-BAG:
PIM IFRS interface summary
- interface-count: integer
-
Number of interfaces
- configuration-count: integer
-
Configuration counts
Example
{
"interface-count": "integer",
"configuration-count": "integer"
}
PIM-TRAFFIC-BAG:
PIM Traffic counters
- input-register-stop: integer
-
Register Stop packets in
- output-ecmp-redirect: integer
-
Output Ecmp Redirect
- invalid-hello-options: integer
-
Number of invalid hello options received
- standby-packets-error: integer
-
Packets received in standby state
- mdt-send-queue-full: integer
-
Packets dropped since mdt send queue was full
- output-prune-group: integer
-
Output Prune Groups
- packet-packman-error: integer
-
Packets Dropped due to Pakman Error
- input-pim-version-error: integer
-
Invalid PIM version error
- input-null-register: integer
-
Null Register packets in
- input-no-vrf-error: integer
-
No VRF for idb error
- output-candidate-rp-advertisement: integer
-
Output Candidate-RP Advertisment
- non-supported-packets: integer
-
PIM non supported pckets
- invalid-registers: integer
-
PIM invalid registers received
- input-jp: integer
-
Join Prune packets in
- invalid-source-encodings: integer
-
Number of invalid source encodings received
- boundary-acl-rx-drop: integer
-
Inc. JP dropped since boundary ACL confg
- no-source-address: integer
-
Packets dropped since no source address
- packet-queue-last-clear: integer
-
Time in seconds since the last clear of all packet queues stats
- invalid-destination-packets: integer
-
Control Packets with Invalid Destination
- output-assert-batched: integer
-
Batched Assert packets out
- mdt-joins-drop-multiple-encapsulation: integer
-
MDT Join msgs dropped due to multiple Encap limitation
- output-register-stop: integer
-
Register Stop packets out
- output-assert: integer
-
Assert packets out
- mdt-join-tlv-received: integer
-
Data MDT Join Msgs received
- send-queue-full: integer
-
Packets dropped since send queue was full
- boundary-acl-tx-drop: integer
-
Out JP dropped since boundary ACL confg
- no-mdt-socket-connection: integer
-
Packets dropped since no mdt socket connection
- packet-queue: PIM-PKTQ
-
Packet queue state and statistics
- output-null-register: integer
-
Null Register packets out
- format-error: integer
-
Malformed packets in
- truncated-pim-packets: integer
-
Packets dropped due to truncated Joins or Prunes
- no-socket-connection: integer
-
Packets dropped since no socket connection
- input-candidate-rp-advertisement: integer
-
Input Candidate-RP Advertisment
- output-hello-bytes: integer
-
Output Hello Bytes
- output-bsr-message: integer
-
Output BSR Messages
- mdt-join-tlv-sent: integer
-
Data MDT Join Msgs sent
- inputs: integer
-
Packets in
- socket-error: integer
-
Socket errors
- output-join-group: integer
-
Output Join Groups
- packets-standby: integer
-
Packets Dropped due to Standby Error
- mdt-drop-local-source-address: integer
-
Data MDT Join msgs dropped due to local source addr
- output-df-election: integer
-
DF Election packets out
- outputs: integer
-
Packets out
- input-assert-batched: integer
-
Batched Assert packets in
- input-ecmp-redirect: integer
-
Input Ecmp Redirect
- input-no-pim-error: integer
-
PIM Disabled on intf error
- mdt-socket-error: integer
-
MDT Socket errors
- input-bsr-message: integer
-
Input BSR Messages
- input-assert: integer
-
Assert packets in
- pakman-error: integer
-
Pakman packets dropped
- elapsed-time: integer
-
Running time for counters in seconds
- input-no-idb-error: integer
-
No IDB for intf error
- checksum-error: integer
-
Checksum errors
- invalid-join-prunes: integer
-
PIM invalid Join/Prunes received
- output-join-prune-bytes: integer
-
Output JP Bytes
- output-hello: integer
-
Hello packets out
- mdt-drop-no-idb: integer
-
Data MDT Join msgs dropped due to idb missing
- packet-read-socket-error: integer
-
Packet Read Socket Error
- output-loop-error: integer
-
Output on loopback error
- input-df-election: integer
-
DF Election packets in
- input-data-register: integer
-
Data Register packets in
- output-jp: integer
-
Join Prune packets out
- input-hello: integer
-
Hello packets in
- mdt-drop-null-local-address: integer
-
Data MDT Join msgs dropped due to null local addr
- mdt-join-bad-type: integer
-
Data MDT TLV bad type
- mdt-drop-no-vrf: integer
-
Data MDT Join msgs dropped due to vrf missing
- mldp-mdt-invalid-lsm-identifier: integer
-
Invalid LSM ID
Example
{
"input-register-stop": "integer",
"output-ecmp-redirect": "integer",
"invalid-hello-options": "integer",
"standby-packets-error": "integer",
"mdt-send-queue-full": "integer",
"output-prune-group": "integer",
"packet-packman-error": "integer",
"input-pim-version-error": "integer",
"input-null-register": "integer",
"input-no-vrf-error": "integer",
"output-candidate-rp-advertisement": "integer",
"non-supported-packets": "integer",
"invalid-registers": "integer",
"input-jp": "integer",
"invalid-source-encodings": "integer",
"boundary-acl-rx-drop": "integer",
"no-source-address": "integer",
"packet-queue-last-clear": "integer",
"invalid-destination-packets": "integer",
"output-assert-batched": "integer",
"mdt-joins-drop-multiple-encapsulation": "integer",
"output-register-stop": "integer",
"output-assert": "integer",
"mdt-join-tlv-received": "integer",
"send-queue-full": "integer",
"boundary-acl-tx-drop": "integer",
"no-mdt-socket-connection": "integer",
"packet-queue": [
{
"packet-queue-stats": {
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
},
"packet-queue-state": {
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
},
"packet-queue-priority": "integer"
}
],
"output-null-register": "integer",
"format-error": "integer",
"truncated-pim-packets": "integer",
"no-socket-connection": "integer",
"input-candidate-rp-advertisement": "integer",
"output-hello-bytes": "integer",
"output-bsr-message": "integer",
"mdt-join-tlv-sent": "integer",
"inputs": "integer",
"socket-error": "integer",
"output-join-group": "integer",
"packets-standby": "integer",
"mdt-drop-local-source-address": "integer",
"output-df-election": "integer",
"outputs": "integer",
"input-assert-batched": "integer",
"input-ecmp-redirect": "integer",
"input-no-pim-error": "integer",
"mdt-socket-error": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"pakman-error": "integer",
"elapsed-time": "integer",
"input-no-idb-error": "integer",
"checksum-error": "integer",
"invalid-join-prunes": "integer",
"output-join-prune-bytes": "integer",
"output-hello": "integer",
"mdt-drop-no-idb": "integer",
"packet-read-socket-error": "integer",
"output-loop-error": "integer",
"input-df-election": "integer",
"input-data-register": "integer",
"output-jp": "integer",
"input-hello": "integer",
"mdt-drop-null-local-address": "integer",
"mdt-join-bad-type": "integer",
"mdt-drop-no-vrf": "integer",
"mldp-mdt-invalid-lsm-identifier": "integer"
}
ROUTE-POLICY:
Common node of vrf, default-context
- route-policy: object
-
PIM route policy
Example
{
"route-policy": {
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"group-address": "string",
"ext-comm": "string",
"source-address": "string",
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
}
IPV4-PIM-ROLE-LVL-OPER-STANDBY:
Common node of pim-ma, pim6-maCommon node of pim, ipv6-pim
- standby: VRF-TABLE
-
Standby Process
Example
{
"standby": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}
}
}
MULTICAST-STATIC-ROUTE-TABLE:
Common node of vrf, default-contextCommon node of vrf, default-context
- multicast-static-routes: object
-
PIM multicast static route table
Example
{
"multicast-static-routes": {
"multicast-static-route": [
{
"prefix-length": "integer",
"address": "string",
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
TOPOLOGY-ROUTE-COUNT:
Common node of vrf, default-context
- topology-route-count: PIM-TT-SUMM-BAG
-
Topology route count information from PIM topology table
Example
{
"topology-route-count": {
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
}
TOPOLOGY-TABLE:
Common node of vrf, default-context
- topologies: object
-
PIM topology table
Example
{
"topologies": {
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean"
}
]
}
}
JP-STATISTICS-TABLE:
Common node of vrf, default-context
- jp-statistics: object
-
PIM join prune statistics table
Example
{
"jp-statistics": {
"jp-statistic": [
{
"interface-name": "string",
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
}
RPF-REDIRECT:
Common node of vrf, default-context
- rpf-redirect: object
-
PIM ECMP RPF-redirect bundle
Example
{
"rpf-redirect": {
"bundle-interfaces": {
"bundle-interface": [
{
"interface-name": "string",
"bundle-name": "string",
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"group-address": "string",
"source-address": "string",
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
}
PIM-ISSU-BAG:
ISSU information
- informationvalid: boolean
-
Is Information valid ?
- role-issu: string
-
ISSU role
- checkpoint-idt-timestamp: integer
-
Time when Checkpoint IDT done
- is-nbr-sync-received: boolean
-
Was NBR Sync achieved ?
- last-ha-role-notification-received: integer
-
Time when last HA role nfn was received
- eoc-received-timestamp: integer
-
Time when EOC was received
- is-rib-sync-received: boolean
-
Was RIB Sync received ?
- last-issu-role-notification-received: integer
-
Time when last ISSU role nfn was received
- is-ihms-done-received: boolean
-
Was IHMS done received ?
- is-eoc-received: boolean
-
Was EOC received ?
- is-checkpoint-idt-done: boolean
-
Was Checkpoint IDT done ?
- ihms-received-timestamp: integer
-
Time when IHMS done was received
- last-issu-phase-notification-received: integer
-
Time when last ISSU Phase nfn was received
- role-ha: string
-
HA role
- phase-issu: string
-
ISSU Phase
- nbr-sync-received-timestamp: integer
-
Time when NBR Sync was achieved
- rib-sync-received-timestamp: integer
-
Time when RIB Sync was received
Example
{
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
}
PIM-MA-IDB:
PIM MA interface
- interface-type: string encap-interface, decap-interface, mdt-interface
-
Interface Type
- vrf-name: string
-
VRF Name
- rp-address: PIM-ADDRTYPE
-
RP Address
- source-address: PIM-ADDRTYPE
-
Source Address
- interface-name-xr: string
-
Interface Name
Example
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
PIM-RPF-INFO-BAG:
PIM RPF information
- rpf-path: PIM-RPF-PATH-BAG
-
RPF Paths list
- is-rpf-bgp-route: boolean
-
Is RPF through BGP route
- metric: integer
-
Metric
- registered-address-xr: PIM-ADDRTYPE
-
Address registered
- metric-preference: integer
-
Metric preference
- is-connected: integer
-
Are we connected ?
Example
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
NET-IO-TUNNEL-TABLE:
Common node of vrf, default-context
- net-io-tunnels: object
-
Tunnel information that NETIO has
Example
{
"net-io-tunnels": {
"net-io-tunnel": [
{
"tunnel-name": "string",
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
TUNNEL-TABLE:
Common node of vrf, default-context
- tunnels: object
-
Tunnels information that PIM has
Example
{
"tunnels": {
"tunnel": [
{
"tunnel-name": "string",
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
PIM-RL-RP-RANGE-BAG:
PIM RP range list information
- prefix: PIM-ADDRTYPE
-
Group range prefix
- source-of-information: PIM-ADDRTYPE
-
Source of information
- prefix-length: string
-
Group range prefix length
- uptime: integer
-
Uptime in seconds
- expires: integer
-
When mapping expires
Example
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
PIM-PKTQ-STATE:
PIM packet queue state per priority
- max-queue-size: integer
-
Maximum size of queue in bytes
- queue-size-packets: integer
-
Size of queue in number of packets
- queue-size-bytes: integer
-
Size of queue in bytes
Example
{
"max-queue-size": "integer",
"queue-size-packets": "integer",
"queue-size-bytes": "integer"
}
PIM-BGP-SAFI-BAG:
PIM BGP SAFI bag
- group: PIM-ADDRTYPE
-
Group address
- is-bgp-added: boolean
-
SAFI learnt from BGP
- extranet-path-count: integer
-
Count of dependent extranet paths
- source: PIM-ADDRTYPE
-
Source address
- route-distinguisher: string
-
Router ID
- next-hop: PIM-ADDRTYPE
-
Next hop address
Example
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PIM-CONTEXT-BAG:
PIM Context bag
- is-in-b-and-mdt-owner: boolean
-
Inband MDT Owner
- sg-expiry-timer-configured: boolean
-
S,G Expiry Timer Configured
- bgp-remote-interface-name: string
-
BGP remote interface name
- is-mrib-register: boolean
-
MRIB Register
- is-create-in-b-and-mdt-interface: boolean
-
Create Inband MDT interface
- is-rib-multipath-interface-hash: boolean
-
PIM RIB multipath interface hash
- mldp-remote-partitioned-mdt-configured: boolean
-
MLDP Remote Partitioned MDT
- anycast-rp-configured: boolean
-
Anycast-RP config
- mldp-control-head-lsm-identifier: integer
-
MLDP MVPN Identifier
- mldp-root-count: integer
-
MLDP Root count
- mldp-partitioned-head-lsm-identifier: integer
-
Partitioned MDT Head LSM-ID
- gin-b-and-mdt-rpf-identifier: integer
-
Inband RPF-ID
- murib-id: integer
-
MURIB ID
- suppress-shared-tree-join: boolean
-
Suppress Shared-Tree Joins
- neighbor-filter-name: string
-
Neighbor Filter Name
- is-socket-added: boolean
-
VRF added on Socket
- rpf-default-table: PIM-TABLE-CTX-BAG
-
RPF Default Table
- is-active: boolean
-
Active
- export-route-target: PIM-RT-EXTCOMM
-
Export Route Targets
- is-multicast-rib-registration: boolean
-
Mcast RIB Registration
- table-count: integer
-
Number of configured Tables
- anycast-rp-policy-name: string
-
Anycast-RP Policy Name
- in-b-and-mdt-interface: string
-
Inband MDT handle
- is-register-injection-socket-added: boolean
-
VRF added on Register Injection Socket
- bgp-source-active-announce: boolean
-
Send BGP Source-Active Announcements
- rump-enabled: boolean
-
PIM is using MuRIB
- is-routing-enabled: boolean
-
Routing Enabled
- mldp-root-address: integer[]
- gin-band-maximum-mdt-aggregation: integer
-
Inband MDT max aggregation
- suppress-pim-data-mdt-tlv: boolean
-
Suppress PIM Data-MDT TLV Announcements
- bgp-remote-interface: string
-
BGP remote interface handle
- maximum-mdt-aggregation: integer
-
MDT max aggregation
- p2mpte-li-drop: integer
-
Route LI updates dropped for P2MP
- mldp-mdt-remote-rpf-identifier: integer
-
MLDP Remote RPF-ID
- rpf-policy-name: string
-
RPF topology selection route-policy name
- stale-rd-present: boolean
-
RD is stale
- rsvp-te-mdt-name: string
-
RSVP-TE MDT Name
- gin-b-and-mdt-interface: string
-
Inband MDT handle
- is-register-injection-lpts-socket-added: boolean
-
VRF LPTS filter added on Register Injection Socket
- import-route-target: PIM-RT-EXTCOMM
-
Import Route Targets
- mhost-interface: string
-
MHost handle
- mldp-mdt-interface: string
-
MLDP MDT handle
- virtual-interface-count: integer
-
Enabled Virtual Interface Count
- in-band-maximum-mdt-aggregation: integer
-
Inband MDT max aggregation
- is-mdt-owner: boolean
-
MDT Owner
- is-default-granges: boolean
-
Default granges
- is-ir-mdt-owner: boolean
-
IR MDT Owner
- ir-mdt-interface: string
-
IRMDT handle
- mldp-bsr-control-tree-added: boolean
-
MLDP BSR Control tree added
- rpf-id: integer
-
RPF ID
- mdt-gre-rpf-identifier: integer
-
GRE-MDT RPF Identifier
- mldp-partioned-mp2m-ptree: boolean
-
MP2MP Partitioned MDT tree
- is-rsvp-te-mdt-owner: boolean
-
RSVP-TE MDT Owner
- umh: boolean
-
Join UMH Core-Tree
- valid-rd-present: boolean
-
RD is valid
- in-b-and-mdt-data-announce-interval: integer
-
Inband Data MDT Announce interval
- is-redistribution-reset: boolean
-
Pending redist reset
- mdt-default-group: string
-
MDT Default group
- in-b-and-mdt-mtu: integer
-
Inband MDT MTU
- mdt-immediate-switch: boolean
-
MDT Immediate Switch
- mdt-data-switchover-interval: integer
-
Data MDT Switchover interval
- gin-b-and-mdt-name: string
-
Inband MDT Name
- is-rib-multipath-source-hash: boolean
-
PIM RIB multipath source based hash
- physical-interface-count: integer
-
Enabled Physical Interface Count
- in-band-signaling-local-enabled: boolean
-
Inband signaling Local enabled
- bgp-auto-discovery-configured: boolean
-
BGP Auto-Discovery configured
- is-mldp-mdt-owner: boolean
-
MLDP MDT Owner
- is-lpts-socket-added: boolean
-
VRF LPTS filter added on Socket
- remote-table-id: integer
-
Remote Table ID
- ir-maximum-mdt-aggregation: integer
-
IR MDT max aggregation
- is-create-mdt-interface: boolean
-
Create MDT interface
- mdt-gre-remote-rpf-identifier: integer
-
GRE-MDT Remote RPF Identifier
- is-socket-add-required: boolean
-
VRF required on Socket
- rsvp-te-mdt-data-announce-interval: integer
-
RSVP-TE Data MDT Announce interval
- gin-b-and-mdt-mtu: integer
-
Inband MDT MTU
- inter-autonomous-system-enabled: boolean
-
Inter-AS Enabled
- mdt-partitioned-mdt-control-identifier: integer
-
Partitioned MDT Control Identifier
- vrf-id: integer
-
VRF ID
- bgp-remote-on: boolean
-
BGP remote interface status
- allow-rp-configured: boolean
-
Allow RP Configured
- virtual-mlc-interface-name: string
-
Virtual master line card Interface
- organization-unique-identifier: integer
-
OUI for VPN-ID
- mldp-auto-rp-announce-tree-added: boolean
-
MLDP Autorp Announce Control tree added
- is-create-ir-mdt-interface: boolean
-
Create IR MDT interface
- mdt-data-announce-interval: integer
-
Data MDT Announce interval
- rsvp-te-mdt-mtu: integer
-
RSVP-TEMDT MTU
- mldp-remote-head-lsm-identifier: integer
-
MLDP Remote Head LSM-ID
- mdt-interface: string
-
MDT handle
- bgp-i-pmsi-added: boolean
-
BGP I-PMSI Added
- rsvp-te-mdt-data-switchover-interval: integer
-
RSVP-TE Data MDT Switchover interval
- rsvp-te-mdt-rpf-identifier: integer
-
RSVP-TE RPF-ID
- anycast-rp-range: PIM-ANYCAST-RP-ENTRY
-
Anycast-RP Ranges
- is-m-host-publish-pending: boolean
-
Publish pending for MHost Default interface
- is-create-mldp-mdt-interface: boolean
-
Create MLDP MDT interface
- is-udp-socket-bind: boolean
-
VRF bound on UDP Socket
- mldp-head-lsm-identifier: integer
-
MLDP Head LSM-ID
- ir-mdt-name: string
-
IR MDT Name
- mldp-mdt-data-switchover-interval: integer
-
MLDP Data MDT Switchover interval
- bgp-remote-state: integer
-
BGP remote interface state
- is-create-gin-b-and-mdt-interface: boolean
-
Create Inband MDT interface
- allow-rp-group-list: string
-
Allow RP Group-List ACL Name
- in-b-and-mdt-data-switchover-interval: integer
-
Inband Data MDT Switchover interval
- is-active-ital: boolean
-
Active ITAL
- mdt-source-interface: string
-
MDT Source Interface Name
- gin-b-and-mdt-data-announce-interval: integer
-
Inband Data MDT Announce interval
- ir-mdt-data-switchover-interval: integer
-
IR Data MDT Switchover interval
- ir-mdt-tail-label: integer
-
IR Tail Label
- ir-mdt-data-announce-interval: integer
-
IR Data MDT Announce interval
- remote-default-group: PIM-ADDRTYPE
-
Remote Default Group
- is-rib-multipath-enabled: boolean
-
PIM RIB multiplath enabled
- is-register-injection-lpts-socket-add-required: boolean
-
VRF LPTS filter required on Register Injection Socket
- is-create-rsvp-te-mdt-interface: boolean
-
Create RSVP-TE MDT interface
- mldp-mdt-rpf-identifier: integer
-
MLDP RPF-ID
- mldp-mdt-data-announce-interval: integer
-
MLDP Data MDT Announce interval
- is-all-interface-disable-operation: boolean
-
PIM all interface disable operation
- mldp-auto-rp-discovery-tree-added: boolean
-
MLDP Autorp Discovery Control tree added
- gin-b-and-mdt-data-switchover-interval: integer
-
Inband Data MDT Switchover interval
- is-pim-nsf-rib-converge-received: boolean
-
PIM NSF RIB converge received
- mdt-source: string
-
MDT source
- vpn-index: integer
-
VPN Index
- is-pim-nsf-rib-converged: boolean
-
PIM NSF RIB converged
- mdt-neighbor-filter-name: string
-
MDT Neighbor Filter Name
- mdt-partitioned-ir-control-identifier: integer
-
Partitioned IR MDT Control Identifier
- route-distinguisher: string
-
RD value
- in-band-signaling-remote-enabled: boolean
-
Inband signaling Remote enabled
- mldp-partitioned-mdt-identifier: integer
-
MLDP Partitioned MDT Identifier
- mdt-mtu: integer
-
MDT MTU
- mldp-maximum-mdt-aggregation: integer
-
MLDP MDT max aggregation
- mldp-partitioned-mdt-configured: boolean
-
MLDP Partitioned MDT
- ir-mdt-mtu: integer
-
IRMDT MTU
- non-default-vrf-count-on-socket: integer
-
Count of non-default vrfs on raw socket
- table-id: integer
-
Table ID
- redistribution-reset-count: integer
-
Redist reset count
- rsvp-te-maximum-mdt-aggregation: integer
-
RSVP-TE MDT max aggregation
- is-register-injection-socket-add-required: boolean
-
VRF required on Register Injection Socket
- mhost-default-interface-config: string
-
Configured Mhost Defint
- is-unicast-rib-registration: boolean
-
Ucast RIB Registration
- mldp-head-local-label: integer
-
Partitioned MDT Head local label
- allow-rp-rp-list: string
-
Allow RP RP-list ACL Name
- active-table-count: integer
-
Number of active Tables
- bgp-auto-discovery-type: integer
-
BGP Auto Discovery Type
- rsvp-te-mdt-static-p2mp-count: integer
-
Number of Static P2MP-TE MDT
- is-auto-rp-listen-sock-add: boolean
-
Auto RP listen sock add
- is-udp-socket-add-required: boolean
-
VRF added on UDP Socket
- is-auto-rp-listen-enabled: boolean
-
Auto RP Listen Enabled
- mldp-mdt-name: string
-
MLDP MDT Name
- bgp-remote-address: string
-
BGP remote interface address
- sg-expiry-timer-sg-list: string
-
S,G expiry timer ACL name
- is-gin-b-and-mdt-owner: boolean
-
Inband MDT Owner
- in-b-and-mdt-name: string
-
Inband MDT Name
- is-udp-socket-added: boolean
-
VRF added on UDP Socket
- is-udp-socket-bind-required: boolean
-
VRF bind required on UDP Socket
- is-rib-multipath-source-next-hop-hash: boolean
-
PIM RIB multipath source-nexthop hash
- rsvp-te-mdt-interface: string
-
RSVP-TEMDT handle
- ir-mdt-rpf-identifier: integer
-
IR RPF-ID
- is-lpts-socket-add-required: boolean
-
VRF LPTS filter required on Socket
- in-b-and-mdt-rpf-identifier: integer
-
Inband RPF-ID
- sg-expiry-time: integer
-
S,G Expiry Time Configured, in seconds
- mldp-mdt-mtu: integer
-
MLDP MDT MTU
Example
{
"is-in-b-and-mdt-owner": "boolean",
"sg-expiry-timer-configured": "boolean",
"bgp-remote-interface-name": "string",
"is-mrib-register": "boolean",
"is-create-in-b-and-mdt-interface": "boolean",
"is-rib-multipath-interface-hash": "boolean",
"mldp-remote-partitioned-mdt-configured": "boolean",
"anycast-rp-configured": "boolean",
"mldp-control-head-lsm-identifier": "integer",
"mldp-root-count": "integer",
"mldp-partitioned-head-lsm-identifier": "integer",
"gin-b-and-mdt-rpf-identifier": "integer",
"murib-id": "integer",
"suppress-shared-tree-join": "boolean",
"neighbor-filter-name": "string",
"is-socket-added": "boolean",
"rpf-default-table": {
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
},
"is-active": "boolean",
"export-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"is-multicast-rib-registration": "boolean",
"table-count": "integer",
"anycast-rp-policy-name": "string",
"in-b-and-mdt-interface": "string",
"is-register-injection-socket-added": "boolean",
"bgp-source-active-announce": "boolean",
"rump-enabled": "boolean",
"is-routing-enabled": "boolean",
"mldp-root-address": [
"integer"
],
"gin-band-maximum-mdt-aggregation": "integer",
"suppress-pim-data-mdt-tlv": "boolean",
"bgp-remote-interface": "string",
"maximum-mdt-aggregation": "integer",
"p2mpte-li-drop": "integer",
"mldp-mdt-remote-rpf-identifier": "integer",
"rpf-policy-name": "string",
"stale-rd-present": "boolean",
"rsvp-te-mdt-name": "string",
"gin-b-and-mdt-interface": "string",
"is-register-injection-lpts-socket-added": "boolean",
"import-route-target": [
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
],
"mhost-interface": "string",
"mldp-mdt-interface": "string",
"virtual-interface-count": "integer",
"in-band-maximum-mdt-aggregation": "integer",
"is-mdt-owner": "boolean",
"is-default-granges": "boolean",
"is-ir-mdt-owner": "boolean",
"ir-mdt-interface": "string",
"mldp-bsr-control-tree-added": "boolean",
"rpf-id": "integer",
"mdt-gre-rpf-identifier": "integer",
"mldp-partioned-mp2m-ptree": "boolean",
"is-rsvp-te-mdt-owner": "boolean",
"umh": "boolean",
"valid-rd-present": "boolean",
"in-b-and-mdt-data-announce-interval": "integer",
"is-redistribution-reset": "boolean",
"mdt-default-group": "string",
"in-b-and-mdt-mtu": "integer",
"mdt-immediate-switch": "boolean",
"mdt-data-switchover-interval": "integer",
"gin-b-and-mdt-name": "string",
"is-rib-multipath-source-hash": "boolean",
"physical-interface-count": "integer",
"in-band-signaling-local-enabled": "boolean",
"bgp-auto-discovery-configured": "boolean",
"is-mldp-mdt-owner": "boolean",
"is-lpts-socket-added": "boolean"
}
PIM-RT-EXTCOMM:
PIM Route-target entry
- segment-border: boolean
-
Segment Border
- configured: boolean
-
Configured Route Target
- update-pending: boolean
-
Update Pending to BGP
- bgp-auto-discovery: boolean
-
BGP Auto Discovery
- route-target: string
-
Route Target Extended community value
- anycast-rp: boolean
-
Anycast-RP Group
- anycast-rp-marked: boolean
-
Anycast-RP Group marked
Example
{
"segment-border": "boolean",
"configured": "boolean",
"update-pending": "boolean",
"bgp-auto-discovery": "boolean",
"route-target": "string",
"anycast-rp": "boolean",
"anycast-rp-marked": "boolean"
}
PIM-PKTQ-STATS:
PIM packet queue statistics per priority
- enqueued-packets: integer
-
Total number of packets enqueued to this queue
- high-water-mark-bytes: integer
-
Highest number of bytes enqueued in this queue
- tail-drops: integer
-
Number packets dropped from this queue due to max size
- dequeued-packets: integer
-
Total number of packets dequeued from this queue
- high-water-mark-packets: integer
-
Highest number of packets enqueued in this queue
Example
{
"enqueued-packets": "integer",
"high-water-mark-bytes": "integer",
"tail-drops": "integer",
"dequeued-packets": "integer",
"high-water-mark-packets": "integer"
}
INTERFACE-OLD-FORMAT-TABLE:
Common node of vrf, default-context
- interface-old-formats: object
-
PIM interfaces in old format
Example
{
"interface-old-formats": {
"interface-old-format": [
{
"interface-name": "string",
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
}
PIM-GRE-HASH-BAG:
PIM GRE Hash Outcome
- next-hop-interface: string
-
Next hop neighbor interface
Example
{
"next-hop-interface": "string"
}
PIM-RPF-RDRCT-BNDL-BAG:
PIM RPF Redirect bundle information
- allocated-threshold-bandwidth: string
-
Configured threshold in Kbps
- available-threshold-bandwidth: string
-
Available threshold in Kbps
- total-bandwidth: string
-
Total bandwidth used in Kbps
- available-bandwidth: string
-
Bandwidth available in Kbps
- rpf-redirect-bundle-name: string
-
RPF redirect bundle name
- topology-bandwidth-used: string
-
Bandwidth used by topology in Kbps
- snooping-bandwidth-used: string
-
Bandwidth used by snooped entries in Kbps
- allocated-bandwidth: string
-
Bandwidth allocated in Kbps
- rpf-redirect-interface-name: string
-
RPF redirect interface name
Example
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
PIM-TT-SUMM-BAG:
PIM topology table summary
- sgr-route-count: integer
-
No. of (S,G)RPT routes
- is-node-low-memory: boolean
-
Is node in low memory condition
- active-group-ranges: integer
-
No. of (*,G/M) routes active in mrib
- sg-route-count: integer
-
No. of (S,G) routes
- group-ranges: integer
-
No. of (*,G/M) routes
- groute-count: integer
-
No. of (*,G) routes
Example
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
PIM-RPF-RDRCT-ROUTE-BAG:
PIM RPF Redirect route information
- interface: PIM-RPF-RDRCT-RINTF-BAG
-
Outgoing interface list
- bandwidth: integer
-
Bandwidth in Kbps
- group-address-xr: PIM-ADDRTYPE
-
Group ddress
- source-address-xr: PIM-ADDRTYPE
-
Source address
- uptime: integer
-
Uptime in seconds
Example
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
PIM-RPF-POLICY-TEST-BAG:
PIM RPF policy test statistics
- extended-community-rt: string
-
Route Target
- afi: integer
-
AFI
- safi: integer
-
SAFI
- policy-name: string
-
RPF policy name
- table-active: boolean
-
Table active
- group-address-xr: PIM-ADDRTYPE
-
Source address
- default-table: boolean
-
Default table selected
- vrf-name: string
-
VRF name
- source-address-xr: PIM-ADDRTYPE
-
Source address
- pass: boolean
-
Pass
- table-name: string
-
Table name
- table-exists: boolean
-
Table exists
Example
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
PIM-MSTATIC-BAG:
Multicast Static Routes entry
- distance: integer
-
Distance
- interface-name: string
-
Interface Handle
- is-via-lsm: boolean
-
LSM flag
- nexthop: PIM-ADDRTYPE
-
Next Hop
- prefix-length-xr: integer
-
Prefix Length
- prefix: PIM-ADDRTYPE
-
Prefix
Example
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
PIM-MA-COMMON-OPER-PIM-MA-SUMMARY-MP:
Common node of active, standby
- pim-ma-summary: PIM-MA-SUMMARY
-
PIM MA summary
Example
{
"pim-ma-summary": {
"is-edm-connection-open": "boolean",
"is-im-connection-open": "boolean",
"decap-interface-count": "integer",
"is-standby-edm-connection-open": "boolean",
"is-netio-connection-open": "boolean",
"encap-interface-count": "integer",
"mdt-interface-count": "integer"
}
}
INTERFACE-TABLE:
Common node of active, standby
- interface-table: object
-
Interface Table
Example
{
"interface-table": {
"interface-by-names": {
"interface-by-name": [
{
"interface-name": "string",
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-handle": "integer",
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
}
PIM-ADDRTYPE:
PIM ADDRTYPE
- af-name: string ipv4-unicast, ipv6-unicast
-
AFName
- ipv6-address: string
-
IPV6 Address
- ipv4-address: string
-
IPv4 Address
Example
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PIM-GRP-MAP-INFORPF-BAG:
PIM group-map information
- group-map-information: PIM-GRP-MAP-BAG
-
Group Mapping information
- are-we-rp: boolean
-
Are we the RP?
- rpf-neighbor: PIM-ADDRTYPE
-
RPF neighbor to the RP
- rpf-interface-name: string
-
RPF interface to the RP
- rpf-vrf-name: string
-
RPF VRF Name
Example
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
MIB-DATABASE-TABLE:
Common node of vrf, default-context
- mib-databases: object
-
PIM group database for mroute mibs table
Example
{
"mib-databases": {
"mib-database": [
{
"source-netmask": "integer",
"group-address": "string",
"source-address": "string",
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
}
interface-table_schema:
Interface Table
- interface-by-names: object
-
Table of PIM MA interfaces indexed by name
- interface-by-handles: object
-
Table of PIM MA interfaces indexed by handle
Example
{
"interface-by-names": {
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
},
"interface-by-handles": {
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
}
interface-by-handles_schema:
Table of PIM MA interfaces indexed by handle
- interface-by-handle: PIM-MA-IDB
-
PIM MA interface referenced by handle
Example
{
"interface-by-handle": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
interface-by-names_schema:
Table of PIM MA interfaces indexed by name
- interface-by-name: PIM-MA-IDB
-
PIM MA interface referenced by name
Example
{
"interface-by-name": [
{
"interface-type": "string",
"vrf-name": "string",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name-xr": "string"
}
]
}
global-interfaces_schema:
PIM global interface table
- global-interface: PIM-IDB-BAG
-
PIM interface name
Example
{
"global-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
ifrs-interfaces_schema:
PIM interfaces in forward reference store table
- ifrs-interface: PIM-IDB-BAG
-
PIM IFRS interface information
Example
{
"ifrs-interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
safs_schema:
SAFI table and type
- saf: object[]
-
SAF name
Example
{
"saf": [
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
]
}
saf_schema:
- rpf-hash-source-groups: object
-
PIM RPF multipath hash outcome
- saf-name: string unicast, multicast, all, default
-
SAF name
- rpfs: object
-
PIM RPF information table
- rpf-hash-sources: object
-
PIM RPF multipath hash outcome
- topology-name: string
-
Topology name
Example
{
"rpf-hash-source-groups": {
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"saf-name": "string",
"rpfs": {
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
},
"rpf-hash-sources": {
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"topology-name": "string"
}
rpf-hash-source-groups_schema:
PIM RPF multipath hash outcome
- rpf-hash-source-group: PIM-RPF-HASH-BAG
-
PIM RPF hash outcome for S,G
Example
{
"rpf-hash-source-group": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
rpf-hash-sources_schema:
PIM RPF multipath hash outcome
- rpf-hash-source: PIM-RPF-HASH-BAG
-
PIM RPF hash outcome for S,G
Example
{
"rpf-hash-source": [
{
"next-hop-interface": "string",
"next-hop-multipath-enabled": "boolean",
"secondary-next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"secondary-next-hop-interface": "string",
"next-hop-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
rpfs_schema:
PIM RPF information table
- rpf: PIM-RPF-INFO-BAG
-
PIM RPF information
Example
{
"rpf": [
{
"rpf-path": [
{
"connector": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"is-via-lsm": "boolean",
"rpf-nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-rpf-interface-disabled": "boolean",
"is-connector-attribute-present": "boolean",
"is-via-mlsm": "boolean",
"extranet-vrf-name": "string"
}
],
"is-rpf-bgp-route": "boolean",
"metric": "integer",
"registered-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"is-connected": "integer"
}
]
}
interface-statistics_schema:
PIM interface statistics
- interface-statistic: PIM-IFSTATS-BAG
-
PIM interface statistics
Example
{
"interface-statistic": [
{
"input-register-stop": "integer",
"input-graft-message": "integer",
"input-graft-ack-message": "integer",
"output-hello": "integer",
"output-df-election": "integer",
"output-register-stop": "integer",
"input-miscellaneous": "integer",
"output-assert": "integer",
"output-graft-ack-message": "integer",
"output-candidate-rp-advertisement": "integer",
"input-bsr-message": "integer",
"input-assert": "integer",
"input-register": "integer",
"input-df-election": "integer",
"output-jp": "integer",
"input-hello": "integer",
"output-graft-message": "integer",
"input-jp": "integer",
"output-register": "integer",
"output-bsr-message": "integer",
"input-candidate-rp-advertisement": "integer"
}
]
}
jp-statistics_schema:
PIM join prune statistics table
- jp-statistic: PIM-JPSTATS-BAG
-
PIM Join Prune Statistics
Example
{
"jp-statistic": [
{
"received": "integer",
"transmitted100": "integer",
"transmitted-1k": "integer",
"received-1k": "integer",
"mtu": "integer",
"received100": "integer",
"transmitted": "integer",
"interface-name-xr": "string",
"received-50k": "integer",
"transmitted-50k": "integer",
"received-10k": "integer",
"transmitted-10k": "integer"
}
]
}
mib-databases_schema:
PIM group database for mroute mibs table
- mib-database: PIM-MROUTE-BAG
-
PIM multicast static route information
Example
{
"mib-database": [
{
"uptime": "integer",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"rpf-mask": "integer",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"rpf-interface-name": "string",
"assert-metric-preference": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"assert-metric": "integer",
"assert-rpt-bit": "boolean",
"rpf-safi": "integer",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-table-name": "string",
"bidirectional-route": "boolean",
"rpf-extranet": "boolean",
"upstream-assert-timer": "string",
"rpf-root": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"spt-bit": "boolean"
}
]
}
neighbor-old-formats_schema:
PIM neighbor table old format
- neighbor-old-format: PIM-NBR-BAG
-
PIM neighbor information
Example
{
"neighbor-old-format": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
ranges_schema:
PIM range list information
- range: PIM-RL-BAG
-
PIM range list information
Example
{
"range": [
{
"protocol": "string",
"group-range": [
{
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length": "string",
"uptime": "integer",
"expires": "integer"
}
],
"client-xr": "string",
"expires": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
interface-old-formats_schema:
PIM interfaces in old format
- interface-old-format: PIM-IDB-BAG
-
PIM interface name
Example
{
"interface-old-format": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
bsr_schema:
PIM BSR information
- bsr-elections: object
-
PIM BSR election state
- candidate-rps: object
-
PIM candidate-RP
- rp-caches: object
-
PIM BSR RP cache table
Example
{
"bsr-elections": {
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rps": {
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
},
"rp-caches": {
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
rp-caches_schema:
PIM BSR RP cache table
- rp-cache: PIM-BSR-RP-CACHE-BAG
-
PIM BSR RP cache
Example
{
"rp-cache": [
{
"group-prefix-length": "integer",
"candidate-rp-list": {
"pim-bsr-crp-bag": [
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"candidate-rp-group-count": "integer",
"group-prefix-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
pim-bsr-crp-bag_schema:
- protocol: string no-route, sm, dm, bidir, ssm, maximum, any
-
PIM Protocol
- candidate-rp-up-time: integer
-
C-RP Uptime
- candidate-rp-holdtime: integer
-
C-RP Holdtime
- candidate-rp-expires: integer
-
C-RP Expires
- candidate-rp-priority: integer
-
C-RP Priority
- candidate-rp-address: PIM-ADDRTYPE
-
C-RP address
Example
{
"protocol": "string",
"candidate-rp-up-time": "integer",
"candidate-rp-holdtime": "integer",
"candidate-rp-expires": "integer",
"candidate-rp-priority": "integer",
"candidate-rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
candidate-rps_schema:
PIM candidate-RP
- candidate-rp: PIM-BSR-CANDIDATE-RP-BAG
-
PIM BSR candidate RP information
Example
{
"candidate-rp": [
{
"candidate-rp-advance-interval": "integer",
"candidate-rp-uptime": "integer",
"candidate-rp": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"acl-name": "string",
"crp-holdtime": "integer",
"candidate-rp-scope": "string",
"crp-priority": "integer",
"crp-access": [
{
"acl-name": "string",
"candidate-rp-mode": "string"
}
],
"candidate-rp-mode": "string"
}
]
}
bsr-elections_schema:
PIM BSR election state
- bsr-election: PIM-BSR-ELECTION-BAG
-
PIM BSR information
Example
{
"bsr-election": [
{
"bsr-up-time": "integer",
"bsr-scope": "integer",
"bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bsr-priority": "integer",
"candidate-bsr-mask-length": "integer",
"candidate-bsr-state": "integer",
"candidate-bsr-priority": "integer",
"bsr-election-state": "integer",
"candidate-bsr-flag": "boolean",
"bsr-mask-length": "integer",
"bootstrap-timeout": "integer",
"candidate-bsr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
route-policy_schema:
PIM route policy
- route-policy-statistics: PIM-RPF-POLICY-STATS-BAG
-
PIM route policy statistics
- route-policy-tests: object
-
PIM route policy test run table
Example
{
"route-policy-statistics": {
"policy-name": "string",
"drop": "integer",
"default-table": "integer",
"pass": "integer",
"requests": "integer",
"any-table": "integer"
},
"route-policy-tests": {
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
}
route-policy-tests_schema:
PIM route policy test run table
- route-policy-test: PIM-RPF-POLICY-TEST-BAG
-
PIM route policy test run
Example
{
"route-policy-test": [
{
"extended-community-rt": "string",
"afi": "integer",
"safi": "integer",
"policy-name": "string",
"table-active": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"default-table": "boolean",
"vrf-name": "string",
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pass": "boolean",
"table-name": "string",
"table-exists": "boolean"
}
]
}
interfaces_schema:
PIM interfaces
- interface: PIM-IDB-BAG
-
PIM interface name
Example
{
"interface": [
{
"join-prune-interval": "integer",
"override-interval": "integer",
"is-bidirectional-capable": "boolean",
"generation-id": "integer",
"virtual-interface": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"idb-acl-provided": "boolean",
"idb-current-count": "integer",
"is-batch-asserts-capable": "boolean",
"neighbor-count": "integer",
"configured-propagation-delay": "integer",
"interface-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"idb-acl-name": "string",
"neighbor-filter-name": "string",
"idb-max-count": "integer",
"idb-oor-enabled": "boolean",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"prune-delay-enabled": "boolean",
"hello-interval": "integer",
"bfd-multiplier": "integer",
"interface-address-mask": "integer",
"is-enabled": "boolean",
"passive-interface": "boolean",
"dr-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"idb-threshold-count": "integer",
"hello-expiry": "integer",
"bfd-interval": "integer",
"bfd-enabled": "boolean",
"external-neighbor-count": "integer",
"are-we-dr": "boolean",
"configured-override-interval": "integer"
}
]
}
net-io-tunnels_schema:
Tunnel information that NETIO has
- net-io-tunnel: PIM-TUNNEL-INFO-BAG
-
PIM netio tunnel information
Example
{
"net-io-tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
bidir-df-states_schema:
Bidirectional PIM DF election state table
- bidir-df-state: PIM-BIDIR-DF-STATE-BAG
-
Bidirectional PIM DF Election Table Entry
Example
{
"bidir-df-state": [
{
"pim-interface-name": "string",
"time-nano-seconds": "integer",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"our-metric": "integer",
"time-seconds": "integer",
"our-metric-preference": "integer",
"election-state": "string"
}
]
}
topologies_schema:
PIM topology table
- topology: PIM-TT-ROUTE-BAG
-
PIM topology information
Example
{
"topology": [
{
"outgoing-interface": [
{
"forwarding-state": "string",
"bgp-c-mcast-join": "boolean",
"jp-timer": "string",
"mvpn-safi-join": "boolean",
"internal-interest-info": "string",
"assert-state": "boolean",
"mdt-safi-join": "boolean",
"mldp-stale": "boolean",
"uptime": "integer",
"extranet-interface": "boolean",
"jp-state": "string",
"immediate-state": "string",
"vrf-name": "string",
"mldp-inband-mdt": "boolean",
"local-members": "string",
"expiry": "integer",
"assert-timer": "string",
"local-members-information": "string",
"assert-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"bgp-c-mcast-prune-delay-timer": "integer",
"sa-prune": "boolean",
"admin-boundary": "boolean",
"interface-name": "string",
"igmp-membership": "boolean",
"mvpnv6-safi-join": "boolean",
"last-hop": "boolean",
"internal-interest-information": "string",
"data-mdt-join": "boolean",
"local-mdt-join": "boolean"
}
],
"protocol": "string",
"sa-sent": "boolean",
"register-received-timer": "string",
"spt": "boolean",
"alive": "string",
"customer-routing-type": "string",
"inherit-spt": "boolean",
"signal-sources": "boolean",
"remote-source": "boolean",
"anycast-rp-route-target": "string",
"uptime": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"register-received": "boolean",
"limit-reached": "boolean",
"rpf-drop": "boolean",
"rpf-vrf-name": "string",
"low-memory": "boolean",
"orig-src-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-proxy-enabled": "boolean",
"sa-received": "boolean",
"sending-null-registers": "boolean",
"rpf-safi": "integer",
"sending-registers": "boolean",
"anycast-rp-match": "boolean",
"rib-mo-frr-enabled": "boolean",
"rpf-extranet": "boolean",
"rpt-xr": "boolean",
"data-mdt-addr-assigned": "boolean",
"vxlan": "boolean",
"mofrr-active": "boolean",
"sa-joined": "boolean",
"crossed-threshold": "boolean",
"rpf-interface-name": "string",
"secondary-rpf-interface-name": "string",
"is-via-lsm": "boolean",
"mofrr-backup": "boolean",
"bgp-join": "boolean",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiry": "integer",
"suppress-registers": "string",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"connected": "boolean",
"proxy": "boolean"
}
]
}
bgp-afs_schema:
PIM BGP SAFI table
- bgp-af: PIM-BGP-SAFI-BAG
-
PIM BGP SAFI information
Example
{
"bgp-af": [
{
"group": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-bgp-added": "boolean",
"extranet-path-count": "integer",
"source": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"route-distinguisher": "string",
"next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
topology-interface-flag-route-counts_schema:
Route count for topology with interface flag set
- topology-interface-flag-route-count: PIM-TT-SUMM-BAG
-
Route count for topology with interface flag set
Example
{
"topology-interface-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
group-map-sources_schema:
PIM group-mapping with source information
- group-map-source: PIM-GRP-MAP-INFOSRC-BAG
-
PIM Group Mapping Entry with source information
Example
{
"group-map-source": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"uptime": "integer",
"source-of-information": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"holdtime": "string",
"expires": "integer"
}
]
}
group-map-rpfs_schema:
PIM group mapping information
- group-map-rpf: PIM-GRP-MAP-INFORPF-BAG
-
PIM group mapping entry
Example
{
"group-map-rpf": [
{
"group-map-information": {
"group-count": "integer",
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"protocol": "string",
"is-used": "boolean",
"mrib-active": "boolean",
"is-override": "boolean",
"priority": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"client": "string",
"prefix-length": "string"
},
"are-we-rp": "boolean",
"rpf-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rpf-interface-name": "string",
"rpf-vrf-name": "string"
}
]
}
gre_schema:
GRE information
- gre-next-hops: object
-
GRE destination neighbor table
- gre-hashes: object
-
GRE hash
Example
{
"gre-next-hops": {
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
},
"gre-hashes": {
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
}
gre-hashes_schema:
GRE hash
- gre-hash: PIM-GRE-HASH-BAG
-
PIM GRE Hashed Underlying Interface
Example
{
"gre-hash": [
{
"next-hop-interface": "string"
}
]
}
gre-next-hops_schema:
GRE destination neighbor table
- gre-next-hop: PIM-GRE-INFO-BAG
-
PIM GRE address next-hop information
Example
{
"gre-next-hop": [
{
"gre-path": [
{
"gre-next-hop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-via-lsm": "boolean",
"is-gre-interface-disabled": "boolean",
"gre-interface-name": "string",
"is-connector-attribute-present": "boolean",
"gre-neighbor": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"extranet-vrf-name": "string"
}
],
"is-connected": "integer",
"metric": "integer",
"metric-preference": "integer",
"registered-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
bidir-df-winners_schema:
Bidirectional PIM DF election winner table
- bidir-df-winner: PIM-BIDIR-DF-BAG
-
Bidirectional PIM DF election table entry
Example
{
"bidir-df-winner": [
{
"uptime": "integer",
"pim-interface-name": "string",
"df-winner": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric": "integer",
"are-we-df": "boolean",
"rp-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"metric-preference": "integer",
"rp-lan": "boolean"
}
]
}
table-contexts_schema:
PIM table context list
- table-context: PIM-TABLE-CTX-BAG
-
PIM table context information
Example
{
"table-context": [
{
"is-ital-registration-done": "boolean",
"afi": "integer",
"safi": "integer",
"table-id": "integer",
"rpf-registrations": "integer",
"vrf-id": "integer",
"is-rib-convergence-received": "boolean",
"is-active": "boolean",
"is-rib-registration-done": "boolean",
"is-rib-convergence": "boolean",
"table-name": "string"
}
]
}
neighbor-summaries_schema:
PIM neighbor summary table
- neighbor-summary: PIM-NBR-SUMM-BAG
-
PIM neighbor summary information
Example
{
"neighbor-summary": [
{
"number-of-neighbors": "string",
"number-of-external-neighbors": "string"
}
]
}
topology-entry-flag-route-counts_schema:
Route count for topology with entry flag set
- topology-entry-flag-route-count: PIM-TT-SUMM-BAG
-
Route count for topology with entry flag set
Example
{
"topology-entry-flag-route-count": [
{
"sgr-route-count": "integer",
"is-node-low-memory": "boolean",
"active-group-ranges": "integer",
"sg-route-count": "integer",
"group-ranges": "integer",
"groute-count": "integer"
}
]
}
rpf-redirect_schema:
PIM ECMP RPF-redirect bundle
- bundle-interfaces: object
-
PIM ECMP RPF-redirect bundle information
- redirect-route-databases: object
-
PIM ECMP RPF-redirect route database
Example
{
"bundle-interfaces": {
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
},
"redirect-route-databases": {
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
}
redirect-route-databases_schema:
PIM ECMP RPF-redirect route database
- redirect-route-database: PIM-RPF-RDRCT-ROUTE-BAG
-
PIM ECMP RPF-redirect route information
Example
{
"redirect-route-database": [
{
"interface": [
{
"rpf-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer",
"is-rpf-interface": "boolean",
"expiry": "integer",
"is-snoop-interface": "boolean",
"is-outgoing-interface": "boolean",
"interface-name": "string"
}
],
"bandwidth": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"source-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"uptime": "integer"
}
]
}
bundle-interfaces_schema:
PIM ECMP RPF-redirect bundle information
- bundle-interface: PIM-RPF-RDRCT-BNDL-BAG
-
PIM ECMP RPF-redirect bundle interface information
Example
{
"bundle-interface": [
{
"allocated-threshold-bandwidth": "string",
"available-threshold-bandwidth": "string",
"total-bandwidth": "string",
"available-bandwidth": "string",
"rpf-redirect-bundle-name": "string",
"topology-bandwidth-used": "string",
"snooping-bandwidth-used": "string",
"allocated-bandwidth": "string",
"rpf-redirect-interface-name": "string"
}
]
}
tunnels_schema:
Tunnels information that PIM has
- tunnel: PIM-TUNNEL-INFO-BAG
-
PIM tunnel information
Example
{
"tunnel": [
{
"source-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"rp-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-name": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"group-address-netio": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
multicast-static-routes_schema:
PIM multicast static route table
- multicast-static-route: PIM-MSTATIC-BAG
-
PIM multicast static route information
Example
{
"multicast-static-route": [
{
"distance": "integer",
"interface-name": "string",
"is-via-lsm": "boolean",
"nexthop": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"prefix-length-xr": "integer",
"prefix": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
neighbors_schema:
PIM neighbor table
- neighbor: PIM-NBR-BAG
-
PIM neighbor information
Example
{
"neighbor": [
{
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
process_schema:
Process
- issu: PIM-ISSU-BAG
-
ISSU Information
- nsr: PIM-NSR-BAG
-
NSR Information
- nsf: PIM-NSF-BAG
-
PIM NSF information
- summary: PIM-SUMMARY-BAG
-
PIM Global Summary
Example
{
"issu": {
"informationvalid": "boolean",
"role-issu": "string",
"checkpoint-idt-timestamp": "integer",
"is-nbr-sync-received": "boolean",
"last-ha-role-notification-received": "integer",
"eoc-received-timestamp": "integer",
"is-rib-sync-received": "boolean",
"last-issu-role-notification-received": "integer",
"is-ihms-done-received": "boolean",
"is-eoc-received": "boolean",
"is-checkpoint-idt-done": "boolean",
"ihms-received-timestamp": "integer",
"last-issu-phase-notification-received": "integer",
"role-ha": "string",
"phase-issu": "string",
"nbr-sync-received-timestamp": "integer",
"rib-sync-received-timestamp": "integer"
},
"nsr": {
"count-connection-up": "integer",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-rmf-ready": "integer",
"partner-connected": "boolean",
"state": "integer",
"count-rmf-not-ready": "integer",
"rmf-timer-expiry": "integer",
"count-connection-dn": "integer",
"last-connection-dn": "integer",
"last-connection-up": "integer",
"last-rmf-ready": "integer",
"rmf-timer-valid": "boolean"
},
"nsf": {
"last-icd-notif-recv-sec": "string",
"last-nsf-off": "string",
"configured-state": "boolean",
"last-icd-notif-recv": "string",
"waiting-timer": "boolean",
"nsf-timeout": "integer",
"respawn-count": "integer",
"nsf-time-left": "integer",
"last-nsf-off-sec": "string",
"last-nsf-on-sec": "string",
"nsf-state": "boolean",
"last-nsf-on": "string",
"waiting-membership": "boolean"
},
"summary": {
"global-bsr-candidate-rp-set-threshold": "integer",
"is-global-register-limit-reached": "boolean",
"route-low-water-mark": "integer",
"global-bsr-ranges-limit": "integer",
"route-count": "integer",
"ranges-threshold": "integer",
"global-bsr-candidate-rp-set-limit": "integer",
"is-global-bsr-ranges-limit-reached": "boolean",
"ranges-count": "integer",
"route-limit": "integer",
"bsr-range-threshold": "integer",
"is-global-route-limit-reached": "boolean",
"global-auto-rp-ranges-limit": "integer",
"is-ranges-limit-reached": "boolean",
"global-bsr-candidate-rp-set-count": "integer",
"global-bsr-ranges-count": "integer",
"route-threshold": "integer",
"bsr-ranges-count": "integer",
"topology-interface-state-threshold": "integer",
"rxi-low-water-mark": "integer",
"register-limit-reached": "boolean",
"register-threshold": "integer",
"rxi-limit-reached": "boolean",
"bsr-candidate-rp-set-limit": "integer",
"is-global-rxi-limit-reached": "boolean",
"topology-interface-state-limit": "integer",
"global-register-limit": "integer",
"register-limit": "integer",
"bsr-ranges-limit": "integer",
"is-maximum-enforcement-disabled": "boolean",
"global-bsr-ranges-threshold": "integer",
"is-node-low-memory": "boolean",
"is-route-limit-reached": "boolean",
"ranges-limit": "integer",
"bsr-candidate-rp-set-count": "integer",
"topology-interface-state-count": "integer",
"is-global-auto-rp-ranges-limit-reached": "boolean",
"is-bsr-ranges-threshold-reached": "boolean",
"bsr-candidate-rp-set-threshold": "integer",
"register-count": "integer"
}
}
vrfs_schema:
VRF Table
- vrf: NEIGHBOR-TABLE
-
VRF name
Example
{
"vrf": [
{
"neighbors": {
"neighbor": [
{
"neighbor-address": "string",
"interface-name": "string",
"uptime": "integer",
"is-bfd-state": "boolean",
"is-bidirectional-capable": "boolean",
"neighbor-address-xr": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"expires": "integer",
"is-ecmp-redirect-capable": "boolean",
"is-this-neighbor-us": "boolean",
"is-dr-priority-capable": "boolean",
"override-interval": "integer",
"is-this-neighbor-dr": "boolean",
"propagation-delay": "integer",
"interface-name-xr": "string",
"dr-priority": "integer",
"is-proxy-capable": "boolean",
"expiry-timer": "integer",
"is-batch-asserts-capable": "boolean"
}
]
}
}
]
}